helix 0.0.4.7.pre → 0.0.4.8.pre

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGNmMmI1MWM4NzhjNWM5YjAyOTkzNGJhZjA1YjIzMTUyYThkMDQxNA==
+    NDdlNDE3OWNiMmYwNmU5Y2NmOGI0NWU2M2YzYmNjNWRjYzA1NzAyMA==
   data.tar.gz: !binary |-
-    YmM3MWJlYmIwMmI1ZDdlMjQyZjhkNzQ0YmMxMGFhMmZlNjMxNDhkZQ==
+    OTQ2MTRkMzQyZDYwYWQ2NGVkYjVmZjczZmViZTUzMThkZmJlNjI1ZA==
 SHA512:
   metadata.gz: !binary |-
-    MDhiM2ZkYTcyZTRlNTVjODkyZWI1NGY3YTY4MGM5ODA5MWUyNmRkNmM3MGEz
-    Mzg0ZjNiOWZlYjkxMjVlMjUxYTY4MTdmZjgzOGMxYjU0OTQxZTkzYWE5N2Nk
-    NWY3MTdiMmMxMGZkODkzYzc5ZmNmZjYwZWJhMjY5MGY2Mjc1MTc=
+    ZGJjYTk3M2RlMGM1NTA4YzhiOTI3MWU0MGJkODhjOTcwOTliMzkxNDJmZDMy
+    YWVhMmU4ODc1MzgyNDM0NGQ1YWM2ZTFiM2NlMGM4NzlmZTdmYmNjZGExZTgw
+    MDQ4MDFiY2U3MDVmYjczYmIyNTBhZWYyMjU2MDY1MDk3ZTE0ZjY=
   data.tar.gz: !binary |-
-    MDgyMWEzN2QxZDljZGQ2MDViMzNmZWJmZmQ4NDRkZGM1NWFlYzkxOGIyNmRk
-    ODk0MTFlYzhjY2RkN2ZjNzA0MmZmZTcxNjkxMWRlMGNlYWQwN2M4NjM5ZDU1
-    MjkyNGY4MzRiNjk4OGYwYjZjMWQxYjNlMjE1ODYyNjdlZTlmNDE=
+    NDhhNWI4NWU0YWYxYWVkOGFlZjhiYjVlZTY0ZTlhYTYwYTc4OTdkZmU0M2Mz
+    MmFiOWNhMjcxYjliOTA4NTVlZGYzM2Q1MWIxYzNmYjVkZDQ0ZmRmM2Q2NzI3
+    OTllNjcyMDkzOGMxNjk2YjgwMTA0MDM1YWU0YTJhZjkzNDdlNDI=

data/lib/helix/config.rb

@@ -38,6 +38,7 @@ module Helix
     # @return [Helix::Config] config returns singleton of Helix::Config
     def self.load_from_hash(desired_credentials)
       config = self.instance
+      desired_credentials = desired_credentials.symbolize_keys
       config.instance_variable_set(:@credentials, desired_credentials)
       RestClient.proxy = config.proxy
       config
@@ -58,7 +59,7 @@ module Helix
     # @param [String] yaml_file_location the yaml file used for config
     # @return [Helix::Config] config returns singleton of Helix::Config
     def self.load_yaml_file(yaml_file_location = DEFAULT_FILENAME)
-      creds  = YAML.load(File.open(yaml_file_location)).symbolize_keys
+      creds  = YAML.load(File.open(yaml_file_location))
       config = load_from_hash(creds)
       config.instance_variable_set(:@filename, yaml_file_location)
       config

data/lib/helix/has_signatures.rb

@@ -3,9 +3,10 @@ module Helix
   module HasSignatures
 
     unless defined?(self::VALID_SIG_TYPES)
-      SIG_DURATION     = 1200 # in minutes
-      TIME_OFFSET      = 1000 * 60 # 1000 minutes, lower to give some margin of error
-      VALID_SIG_TYPES  = [ :ingest, :update, :view ]
+      REQUIRES_CONTRIBUTOR = Set.new([ :ingest, :upload ])
+      SIG_DURATION         = 1200 # in minutes
+      TIME_OFFSET          = 1000 * 60 # 1000 minutes, lower to give some margin of error
+      VALID_SIG_TYPES      = Set.new([ :ingest, :update, :upload, :view ])
     end
 
     def clear_signatures!
@@ -51,6 +52,27 @@ module Helix
       [contributor, library, company]
     end
 
+    # Returns the proper Twistage ApiController action for the specific sig_type.
+    #
+    # @param [Symbol] sig_type The type of signature required for calls.
+    # @return [String] The action, such as ingest_key in '.../api/ingest_key'
+    # which will return a usable signature of that type when given a proper
+    # licenseKey parameter in the query string.
+    #
+    # Why does this method exist? The key types returnable by the Twistage API
+    # include [ :ingest, :update, :view ]. Typically, :update and :view keys are
+    # memoized, whereas :ingest keys are not.
+    #
+    # However, Helix upload actions require persistent signatures across multiple
+    # sub-actions, so within Helix, we have provided the alias :upload, which
+    # means "memoized :ingest". Interactions with the Twistage API will still be
+    # as :ingest, but the internal label within Helix will be :upload, in order
+    # to easily allow the needed memoization and also disambiguate.
+    def key_action_for(sig_type)
+      key_type = {upload: :ingest}[sig_type] || sig_type
+      "#{key_type}_key"
+    end
+
     def license_key
       @credentials[:license_key]
     end
@@ -73,9 +95,10 @@ module Helix
 
     def signature_url_for(sig_type, opts={})
       contributor, library, company = get_contributor_library_company(opts)
-      url  = "#{credentials[:site]}/api/#{sig_type}_key?"
+      key_action = key_action_for(sig_type)
+      url  = "#{credentials[:site]}/api/#{key_action}?"
       url += "licenseKey=#{credentials[:license_key]}&duration=#{SIG_DURATION}"
-      url += "&contributor=#{contributor}" if sig_type == :ingest
+      url += "&contributor=#{contributor}" if REQUIRES_CONTRIBUTOR.include?(sig_type)
       url += "&library_id=#{library}"   if library
       url += "&company_id=#{company}"   if company
       url

data/lib/helix/uploadable.rb

@@ -15,7 +15,7 @@ module Helix
       end
 
       def upload_server_name(http_open_opts={})
-        upload_get(:http_open, ingest_sig_opts, http_open_opts)
+        upload_get(:http_open, upload_sig_opts, http_open_opts)
       end
 
       def http_open(opts={})
@@ -48,17 +48,17 @@ module Helix
         "#{url}?#{query_string}"
       end
 
-      def ingest_sig_opts
+      def upload_sig_opts
         cc = config.credentials
-        ingest_sig_opts = {
+        upload_sig_opts = {
           contributor: cc[:contributor],
           company_id:  cc[:company],
           library_id:  cc[:library],
         }
       end
 
-      def upload_get(action, ingest_sig_opts={}, http_open_opts={})
-        guid     = config.signature(:ingest, ingest_sig_opts)
+      def upload_get(action, upload_sig_opts={}, http_open_opts={})
+        guid     = config.signature(:upload, upload_sig_opts)
         url_opts = {
           resource_label: "upload_sessions",
           guid:           guid,

data/spec/config_spec.rb

@@ -27,6 +27,10 @@ describe Helix::Config do
       subject { klass::ITEMS_PER_PAGE }
       it { should eq(100) }
     end
+    describe "REQUIRES_CONTRIBUTOR" do
+      subject { klass::REQUIRES_CONTRIBUTOR }
+      it { should eq(Set.new([:ingest, :upload])) }
+    end
     describe "SCOPES" do
       subject { klass::SCOPES }
       it { should eq([:reseller, :company, :library]) }
@@ -45,7 +49,7 @@ describe Helix::Config do
     end
     describe "VALID_SIG_TYPES" do
       subject { klass::VALID_SIG_TYPES }
-      it { should eq([:ingest, :update, :view]) }
+      it { should eq(Set.new([:ingest, :update, :upload, :view])) }
     end
   end
 
@@ -62,9 +66,11 @@ describe Helix::Config do
     end
     meths.each do |meth|
       context "when given a Hash" do
-        it "should set the instance's credentials to that Hash arg" do
-          mock_obj.should_receive(:instance_variable_set).with(:@credentials, :the_hash_arg)
-          klass.send(meth, :the_hash_arg)
+        let(:the_hash_arg) { double('Hash') }
+        it "should set the instance's credentials to the key-symbolized version of that Hash arg" do
+          the_hash_arg.should_receive(:symbolize_keys) { :symbolized }
+          mock_obj.should_receive(:instance_variable_set).with(:@credentials, :symbolized)
+          klass.send(meth, the_hash_arg)
         end
       end
     end

data/spec/document_spec.rb

@@ -29,8 +29,8 @@ describe Helix::Document do
 
   ### CLASS METHODS
 
-  describe ".ingest_sig_opts" do
-    let(:meth)        { :ingest_sig_opts }
+  describe ".upload_sig_opts" do
+    let(:meth)        { :upload_sig_opts }
     let(:mock_config) { double(Helix::Config, credentials: {}) }
     subject           { klass.method(meth) }
     its(:arity)       { should eq(0) }
@@ -61,7 +61,7 @@ describe Helix::Document do
     end
   end
 
-  it_behaves_like "ingest_sig_opts", Helix::Document
+  it_behaves_like "upload_sig_opts", Helix::Document
   it_behaves_like "uploads",         Helix::Document
 
 end

data/spec/spec_helper.rb

@@ -7,7 +7,7 @@ SimpleCov.start do
 end
 
 require 'support/downloads'
-require 'support/ingest_sig_opts'
+require 'support/upload_sig_opts'
 require 'support/plays'
 require 'support/uploads'
 

data/spec/track_spec.rb

@@ -31,7 +31,7 @@ describe Helix::Track do
 
   ### CLASS METHODS
 
-  it_behaves_like "ingest_sig_opts", Helix::Track
+  it_behaves_like "upload_sig_opts", Helix::Track
   it_behaves_like "uploads",         Helix::Track
 
 end

data/spec/video_spec.rb

@@ -123,7 +123,7 @@ describe Helix::Video do
 
   ### CLASS METHODS
 
-  it_behaves_like "ingest_sig_opts", Helix::Video
+  it_behaves_like "upload_sig_opts", Helix::Video
   it_behaves_like "uploads",         Helix::Video
 
   describe ".slice" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helix
 version: !ruby/object:Gem::Version
-  version: 0.0.4.7.pre
+  version: 0.0.4.8.pre
 platform: ruby
 authors:
 - Twistage, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json