helix 0.0.3.1.pre → 0.0.3.2.pre

data/lib/helix.rb

@@ -6,6 +6,7 @@ require 'helix/track'
 require 'helix/tag'
 require 'helix/album'
 require 'helix/image'
+require 'helix/document'
 require 'helix/config'
 require 'helix/statistics'
 require 'helix/library'

data/lib/helix/document.rb

@@ -0,0 +1,19 @@
+require 'helix/media'
+
+module Helix
+
+  class Document < Media
+
+    # The class name, to be used by supporting classes. Such as Config which uses
+    # this method as a way to build URLs.
+    #
+    #
+    # @example
+    #   Helix::Document.resource_label_sym #=> :document
+    #
+    # @return [Symbol] Name of the class.
+    def self.resource_label_sym; :document; end
+
+  end
+
+end

data/spec/document_spec.rb

@@ -0,0 +1,137 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'helix'
+
+describe Helix::Document do
+  let(:klass) { Helix::Document }
+
+  subject { klass }
+  mods = [ Helix::Base, Helix::Media ]
+  mods.each { |mod| its(:ancestors) { should include(mod) } }
+  its(:guid_name) { should eq('document_id') }
+  its(:resource_label_sym)    { should be(:document)   }
+  its(:plural_resource_label) { should eq('documents') }
+  [:find, :create, :all, :find_all, :where].each do |crud_call|
+    it { should respond_to(crud_call) }
+  end
+
+  describe "Constants"
+
+  ### INSTANCE METHODS
+
+  describe "an instance" do
+    let(:obj) { klass.new({'document_id' => 'some_document_guid'}) }
+    subject { obj }
+    its(:resource_label_sym) { should be(:document) }
+    [:destroy, :update].each do |crud_call|
+      it { should respond_to(crud_call) }
+    end
+  end
+
+  ### CLASS METHODS
+
+  describe ".upload" do
+    let(:meth)            { :upload }
+    let(:mock_config)     { mock(Helix::Config) }
+    subject               { klass.method(meth) }
+    its(:arity)           { should eq(1) }
+    let(:file_hash)       { { file: :some_file  } }
+    let(:multipart_hash)  { { multipart: true } }
+    it "should call upload_server_name and RestClient.post with params" do
+      klass.should_receive(:upload_server_name) { :some_server_url }
+      File.should_receive(:new).with(:some_file.to_s, "rb") { :some_file }
+      RestClient.should_receive(:post).with(:some_server_url,
+                                            file_hash,
+                                            multipart_hash)
+      klass.should_receive(:http_close)
+      klass.send(meth, :some_file)
+    end
+  end
+
+  describe ".upload_server_name" do
+    let(:meth)        { :upload_server_name }
+    let(:mock_config) { mock(Helix::Config) }
+    subject           { klass.method(meth) }
+    its(:arity)       { should eq(0) }
+    let(:url_opts)    { { resource_label: "upload_sessions",
+                          guid:           :some_sig,
+                          action:         :http_open,
+                          content_type:   ""  } }
+    before            { Helix::Config.stub(:instance) { mock_config } }
+    it "should call RestClient.get with correct url building" do
+      mock_config.should_receive(:build_url).with(url_opts) { :url }
+      mock_config.should_receive(:signature).with(:ingest) { :some_sig }
+      RestClient.should_receive(:get).with(:url)
+      klass.send(meth)
+    end
+  end
+
+  describe ".http_close" do
+    let(:meth)        { :http_close }
+    let(:mock_config) { mock(Helix::Config) }
+    subject           { klass.method(meth) }
+    its(:arity)       { should eq(0) }
+    let(:url_opts)    { { resource_label: "upload_sessions",
+                          guid:           :some_sig,
+                          action:         :http_close,
+                          content_type:   ""  } }
+    before            { Helix::Config.stub(:instance) { mock_config } }
+    it "should call RestClient.get with correct url building" do
+      mock_config.should_receive(:build_url).with(url_opts) { :url }
+      mock_config.should_receive(:signature).with(:ingest) { :some_sig }
+      RestClient.should_receive(:get).with(:url)
+      klass.send(meth)
+    end
+  end
+
+  describe ".upload_get" do
+    let(:meth)        { :upload_get }
+    let(:mock_config) { mock(Helix::Config) }
+    subject           { klass.method(meth) }
+    its(:arity)       { should eq(1) }
+    let(:url_opts)    { { resource_label: "upload_sessions",
+                          guid:           :some_sig,
+                          action:         :upload_get,
+                          content_type:   ""  } }
+    before            { Helix::Config.stub(:instance) { mock_config } }
+    it "should call RestClient.get with correct url building" do
+      mock_config.should_receive(:build_url).with(url_opts) { :url }
+      mock_config.should_receive(:signature).with(:ingest) { :some_sig }
+      RestClient.should_receive(:get).with(:url)
+      klass.send(meth, :upload_get)
+    end
+  end
+
+  describe ".http_open" do
+    let(:meth)        { :http_open }
+    let(:mock_config) { mock(Helix::Config) }
+    subject           { klass.method(meth) }
+    its(:arity)       { should eq(0) }
+    it "should call upload_server_name" do
+      klass.should_receive(:upload_server_name)
+      klass.send(meth)
+    end
+  end
+
+  describe ".upload_open" do
+    let(:meth)        { :upload_open }
+    let(:mock_config) { mock(Helix::Config) }
+    subject           { klass.method(meth) }
+    its(:arity)       { should eq(0) }
+    it "should call upload_server_name" do
+      klass.should_receive(:upload_server_name)
+      klass.send(meth)
+    end
+  end
+
+  describe ".upload_close" do
+    let(:meth)        { :upload_close }
+    let(:mock_config) { mock(Helix::Config) }
+    subject           { klass.method(meth) }
+    its(:arity)       { should eq(0) }
+    it "should call upload_server_name" do
+      klass.should_receive(:http_close)
+      klass.send(meth)
+    end
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: helix
 version: !ruby/object:Gem::Version 
   prerelease: 8
-  version: 0.0.3.1.pre
+  version: 0.0.3.2.pre
 platform: ruby
 authors: 
 - Twistage, Inc
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-13 00:00:00 Z
+date: 2013-05-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -68,7 +68,7 @@ dependencies:
   type: :runtime
   version_requirements: *id005
 description: Provides helper libraries for Ruby access to the Twistage API
-email: kbaird@twistage.com
+email: kevin.baird@perceptivesoftware.com, michael.wood@perceptivesoftware.com
 executables: []
 
 extensions: []
@@ -84,6 +84,7 @@ files:
 - lib/helix/library.rb
 - lib/helix/uploadable.rb
 - lib/helix/statistics.rb
+- lib/helix/document.rb
 - lib/helix/video_playlist.rb
 - lib/helix/media.rb
 - lib/helix/video.rb
@@ -94,6 +95,7 @@ files:
 - lib/helix/track.rb
 - lib/helix/exceptions.rb
 - lib/helix/config.rb
+- spec/document_spec.rb
 - spec/audio_playlist_spec.rb
 - spec/library_spec.rb
 - spec/spec_helper.rb