helix 0.0.0.pre → 0.0.1.pre

data/README.md

@@ -1,6 +1,3 @@
-http://nestacms.com/docs/creating-content/markdown-cheat-sheet
-http://support.mashery.com/docs/customizing_your_portal/Markdown_Cheat_Sheet
-
 # Helix
 
 The Helix gem allows developers to easily connect to and manipulate the Twistage API.
@@ -60,7 +57,7 @@ Supported Ruby versions
 
 How To
 ------
-
+Warning: How To is not currently finished, it may be inaccurate. 
 ###Setup YAML
 ```yaml
 site: 'http://service.twistage.com'
@@ -159,11 +156,11 @@ Credits
 
 Helix was written by Kevin Baird and Michael Wood.
 
-Helix is maintained and funded by [Twistage, inc](http://twistage.com)
+Helix is maintained and funded by [Twistage, Inc](http://twistage.com)
 
-The names and logos for twistage are trademarks of twistage, inc.
+The names and logos for twistage are trademarks of Twistage, Inc.
 
 License
 -------
 
-Helix is Copyright © 2008-2012 Twistage, inc.
+Helix is Copyright © 2008-2012 Twistage, Inc.

data/lib/helix/base.rb

@@ -1,7 +1,7 @@
 require 'rest_client'
 require 'json'
 require 'yaml'
-require 'crack'
+require 'active_support/core_ext'
 
 module Helix
   class Base
@@ -18,26 +18,16 @@ module Helix
     # normally be called as Helix::Base.create
     #
     # @example
-    #   Helix::Video.create({title: "My new video"})
+    #   Helix::Album.create({title: "My new album"})
     #
     # @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
-      #xml       = '<?xml version="1.0" encoding="UTF-8"?>
-      #              <add>
-      #                <list>
-      #                  <entry>
-      #                    <src>http://www.minhreigen.com/videos/play.mp4</src>
-      #                    <title>Summer camp dance</title>
-      #                    <description>This one is the best</description>
-      #                  </entry>
-      #                </list>
-      #              </add>'.gsub!(/\s{2,}|\n/, "")
       url       = config.build_url(media_type:  plural_media_type,
                                    format:      :xml)
       response  = RestClient.post(url, attributes.merge(signature: config.signature(:update)))
-      attrs     = Crack::XML.parse(response)
+      attrs     = Hash.from_xml(response)
       self.new(attributes: attrs[media_type_sym.to_s], config: config)
     end
 

data/lib/helix/video.rb

@@ -1,4 +1,5 @@
 require 'helix/base'
+require 'active_support/core_ext'
 
 module Helix
 
@@ -14,6 +15,61 @@ module Helix
     # @return [Symbol] Name of the class.
     def self.media_type_sym; :video; end
 
-  end
+    # Used to import videos from a URL into the Twistage system.
+    #
+    # @example
+    #   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), self.get_params)
+    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.
+    #
+    #
+    # @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  = { contributor: :helix, library_id: :development }
+      sig   = Helix::Config.instance.signature(:ingest, opts)
+      { params: { signature: sig } } 
+    end
+
+  end
 end

data/spec/base_spec.rb

@@ -45,7 +45,7 @@ describe Helix::Base do
       mock_config.should_receive(:build_url).with(media_type: :klasses,
                                                   format:     :xml)
       RestClient.stub(:post).with(:url, params) { resp_json }
-      Crack::XML.should_receive(:parse).with(resp_json) { resp_value }
+      Hash.should_receive(:from_xml).with(resp_json) { resp_value }
       klass.stub(:new).with(expected)
       mock_config.should_receive(:signature).with(:update) { "some_sig" }
       klass.send(meth)
@@ -54,7 +54,7 @@ describe Helix::Base do
       mock_config.should_receive(:build_url).with(media_type: :klasses,
                                                   format:     :xml)
       RestClient.should_receive(:post).with(:url, params) { resp_json }
-      Crack::XML.should_receive(:parse).with(resp_json) { resp_value }
+      Hash.should_receive(:from_xml).with(resp_json)      { resp_value }
       klass.should_receive(:new).with(expected)
       klass.send(meth)
     end

data/spec/video_spec.rb

@@ -2,20 +2,100 @@ require File.expand_path('../spec_helper', __FILE__)
 require 'helix'
 
 describe Helix::Video do
+
+  def import_xml(values={})
+    { list: { entry: values } }.to_xml(root: :add)
+  end
+
   let(:klass) { Helix::Video }
 
-  subject { klass }
-  its(:ancestors) { should include(Helix::Base) }
-  its(:guid_name) { should eq('video_id') }
+  subject                 { klass }
+  its(:ancestors)         { should include(Helix::Base) }
+  its(:guid_name)         { should eq('video_id') }
   its(:media_type_sym)    { should be(:video)   }
   its(:plural_media_type) { should eq('videos') }
 
   describe "Constants"
 
+  let(:sig_opts)  { { contributor:  :helix, 
+                      library_id:   :development } }
+  let(:url_opts)  { { action:       :create_many, 
+                      media_type:   "videos", 
+                      format:       :xml } }
+
   describe "an instance" do
-    let(:obj) { klass.new({'video_id' => 'some_video_guid'}) }
-    subject { obj }
-    its(:media_type_sym) { should be(:video) }
+    let(:obj)             { klass.new({'video_id' => 'some_video_guid'}) }
+    subject               { obj }
+    its(:media_type_sym)  { should be(:video) }
+  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(0) }
+    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

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.pre
   prerelease: 6
-  version: 0.0.0.pre
 platform: ruby
-authors: 
-- Twistage
+authors:
+- Twistage, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-19 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-21 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: crack
   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: activesupport
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.3.1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.9
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.9
 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/statistics.rb
 - lib/helix/image.rb
+- lib/helix/album.rb
+- lib/helix/config.rb
+- lib/helix/base.rb
+- spec/video_spec.rb
+- spec/album_spec.rb
+- spec/config_spec.rb
 - spec/base_spec.rb
 - spec/statistics_spec.rb
-- spec/config_spec.rb
+- spec/spec_helper.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