helix 0.0.4.1.pre → 0.0.4.2.pre

data/lib/helix/config.rb

@@ -50,7 +50,7 @@ module Helix
     # @return [String] The full RESTful URL string object
     def add_sub_urls(base_url, opts)
       guid, action, format = [:guid, :action, :formats].map { |sub| opts[sub] }
-      url   = "#{base_url}/#{opts[:resource_label]}"
+      url   = sub_url_scoping(base_url, opts)
       url  += "/#{guid}"            if guid
       url  += "/formats/#{format}"  if format
       url  += "/#{action}"          if action
@@ -174,6 +174,16 @@ module Helix
 
     private
 
+    def sub_url_scoping(base_url, opts)
+      resource_label = opts[:resource_label]
+      if resource_label == 'libraries'
+        co_id = opts[:company] || credentials[:company]
+        raise "No company to scope to: #{credentials}" if co_id.nil?
+        resource_label = "companies/#{co_id}/libraries"
+      end
+      "#{base_url}/#{resource_label}"
+    end
+
     def error_message_for(sig_type)
       "I don't understand '#{sig_type}'. Please give me one of :ingest, :update, or :view."
     end
@@ -183,6 +193,14 @@ module Helix
       @signature_for[license_key][sig_type]
     end
 
+    def get_contributor_library_company(opts)
+      sig_param_labels = [:contributor, :library, :company]
+      scoping_proc     = lambda { |key| opts[key] || credentials[key] }
+      contributor, library, company = sig_param_labels.map(&scoping_proc)
+      contributor    ||= 'helix_default_contributor'
+      [contributor, library, company]
+    end
+
     def license_key
       @credentials[:license_key]
     end
@@ -227,12 +245,12 @@ module Helix
     end
 
     def url_for(sig_type, opts={})
-      contributor, library_id, company_id = [:contributor, :library_id, :company_id].map { |key| opts[key] }
-      contributor ||= (credentials[:contributor] || 'helix_default_contributor')
-      url  = "#{credentials[:site]}/api/#{sig_type}_key?licenseKey=#{credentials[:license_key]}&duration=#{SIG_DURATION}"
+      contributor, library, company = get_contributor_library_company(opts)
+      url  = "#{credentials[:site]}/api/#{sig_type}_key?"
+      url += "licenseKey=#{credentials[:license_key]}&duration=#{SIG_DURATION}"
       url += "&contributor=#{contributor}" if sig_type == :ingest
-      url += "&library_id=#{library_id}"   if library_id
-      url += "&company_id=#{company_id}"   if company_id
+      url += "&library_id=#{library}"   if library
+      url += "&company_id=#{company}"   if company
       url
     end
 

data/lib/helix/hash_ext.rb

@@ -93,7 +93,7 @@ class Hash
   # configure your own builder with the <tt>:builder</tt> option. The method also accepts
   # options like <tt>:dasherize</tt> and friends, they are forwarded to the builder.
   def to_xml(options = {})
-    
+
     options = options.dup
     options[:indent]  ||= 2
     options[:root]    ||= 'hash'

data/lib/helix/library.rb

@@ -9,6 +9,10 @@ module Helix
     # @return [String] A blank String
     def self.create(attrs={}); super; end
 
+    def self.find(nickname, opts={})
+      Helix::RESTful.find(nickname, opts.merge(content_type: :xml))
+    end
+
     # The class name, to be used by supporting classes. Such as Config which uses
     # this method as a way to build URLs.
     #

data/spec/config_spec.rb

@@ -204,8 +204,8 @@ describe Helix::Config do
       subject { obj.send(meth, {guid: :the_guid, action: :the_action}) }
       it_behaves_like "reads scope from credentials for build_url", :videos, :xml, {guid: :the_guid, action: :the_action}
     end
-    [ :videos, :tracks ].each do |resource_label|
-      context "when given opts[:resource_label] of :#{resource_label}" do
+    %w[ videos tracks ].each do |resource_label|
+      context "when given opts[:resource_label] of '#{resource_label}'" do
         subject { obj.send(meth, resource_label: resource_label) }
         it_behaves_like "reads scope from credentials for build_url", resource_label, :xml
       end
@@ -222,6 +222,23 @@ describe Helix::Config do
         it_behaves_like "reads scope from credentials for build_url", resource_label, :xml, {guid: :the_guid, action: :the_action}
       end
     end
+    %w[ libraries ].each do |resource_label|
+      context "when there is no company in credentials" do
+        context "when given opts[:resource_label] of '#{resource_label}'" do
+          it "should raise a no company error" do
+            the_proc = lambda { obj.send(meth, resource_label: resource_label) }
+            expect(the_proc).to raise_error
+          end
+        end
+      end
+      context "when there is a company in credentials" do
+        before(:each) do obj.credentials.merge!(company: :the_co_id) end
+        context "when given opts[:resource_label] of '#{resource_label}'" do
+          subject { obj.send(meth, resource_label: resource_label) }
+          it { should eq("http://example.com/companies/the_co_id/companies/the_co_id/libraries.xml") }
+        end
+      end
+    end
     [ :json, :xml ].each do |content_type|
       context "when given opts[:content_type] of :#{content_type}" do
         subject { obj.send(meth, content_type: content_type) }
@@ -549,10 +566,16 @@ describe Helix::Config do
         obj.instance_variable_set(:@signature_expiration_for, sig_exp_for)
         RestClient.stub(:get) { :fresh_sig }
       end
+      before(:each) do
+        Helix::Config.instance.credentials[:company] = "the_co"
+        Helix::Config.instance.credentials[:library] = "default"
+      end
       it "should call RestClient.get(#{url})" do
         set_stubs(obj)
         url  = "#{obj.credentials[:site]}/api/#{sig_type}_key?licenseKey=#{license_key}&duration=1200"
         url += "&contributor=helix_default_contributor" if sig_type == :ingest
+        url += "&library_id=default"
+        url += "&company_id=the_co"
         RestClient.should_receive(:get).with(url) { :fresh_sig }
         expect(obj.send(meth, sig_type)).to be(:fresh_sig)
       end

data/spec/library_spec.rb

@@ -30,6 +30,24 @@ describe Helix::Library do
 
   describe "Constants"
 
+  describe ".find" do
+    let(:meth)  { :find }
+    subject     { klass.method(meth) }
+    its(:arity) { should eq(-2) }
+    context "when given just a nickname" do
+      it "should call super(nickname, {content_type: :xml})" do
+        Helix::RESTful.should_receive(:find).with(:a_nickname, {content_type: :xml})
+        klass.send(meth, :a_nickname)
+      end
+    end
+    context "when given a nickname and opts" do
+      it "should call super(nickname, opts.merge(content_type: :xml))" do
+        Helix::RESTful.should_receive(:find).with(:a_nickname, {content_type: :xml, k: :v})
+        klass.send(meth, :a_nickname, {k: :v})
+      end
+    end
+  end
+
   describe "an instance" do
     let(:obj)            { klass.new({'library_id' => 'some_library_id'}) }
     subject              { obj }
@@ -38,4 +56,5 @@ describe Helix::Library do
       it { should respond_to(crud_call) }
     end
   end
+
 end

metadata

@@ -1,128 +1,137 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: helix
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.4.2.pre
   prerelease: 8
-  version: 0.0.4.1.pre
 platform: ruby
-authors: 
+authors:
 - Twistage, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-09-04 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-09-11 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
+        version: 1.5.4
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: nori
   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 
+    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: kevin.baird@perceptivesoftware.com, michael.wood@perceptivesoftware.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/helix.rb
-- lib/helix/user.rb
+- lib/helix/album.rb
+- lib/helix/audio_playlist.rb
+- lib/helix/base.rb
+- lib/helix/config.rb
 - lib/helix/document.rb
-- lib/helix/tag.rb
+- lib/helix/durationed.rb
+- lib/helix/exceptions.rb
+- lib/helix/hash_ext.rb
+- lib/helix/image.rb
+- lib/helix/library.rb
 - lib/helix/media.rb
-- lib/helix/statistics.rb
 - lib/helix/object_ext.rb
-- lib/helix/library.rb
-- lib/helix/audio_playlist.rb
-- lib/helix/uploadable.rb
-- lib/helix/durationed.rb
 - lib/helix/playlist.rb
 - lib/helix/restful.rb
-- lib/helix/video_playlist.rb
-- lib/helix/config.rb
-- lib/helix/video.rb
+- lib/helix/statistics.rb
+- lib/helix/tag.rb
 - lib/helix/track.rb
-- lib/helix/base.rb
-- lib/helix/image.rb
-- lib/helix/album.rb
-- lib/helix/exceptions.rb
-- lib/helix/hash_ext.rb
-- spec/spec_helper.rb
+- lib/helix/uploadable.rb
+- lib/helix/user.rb
+- lib/helix/video.rb
+- lib/helix/video_playlist.rb
+- spec/_integration_spec.rb
+- spec/album_spec.rb
 - spec/audio_playlist_spec.rb
+- spec/base_spec.rb
 - spec/config_spec.rb
-- spec/image_spec.rb
-- spec/media_spec.rb
+- spec/document_spec.rb
 - spec/durationed_spec.rb
 - spec/helix_spec.rb
-- spec/document_spec.rb
-- spec/album_spec.rb
+- spec/image_spec.rb
+- spec/library_spec.rb
+- spec/media_spec.rb
+- spec/playlist_spec.rb
+- spec/spec_helper.rb
 - spec/statistics_spec.rb
-- spec/_integration_spec.rb
 - spec/tag_spec.rb
-- spec/video_playlist_spec.rb
 - spec/track_spec.rb
 - spec/user_spec.rb
+- spec/video_playlist_spec.rb
 - spec/video_spec.rb
-- spec/playlist_spec.rb
-- spec/library_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.11
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Wrapper library for the video API
 test_files: []
-
+has_rdoc: yard