helix 0.0.1.5.pre → 0.0.1.6.pre

data/lib/helix.rb

@@ -1,3 +1,4 @@
+require 'helix/durationed_media'
 require 'helix/video'
 require 'helix/track'
 require 'helix/album'

data/lib/helix/config.rb

@@ -19,6 +19,7 @@ module Helix
     end
 
     attr_accessor :credentials
+    attr_reader   :signature_for, :signature_expiration_for
 
     # Creates a singleton of itself, setting the config
     # to a specified YAML file. If no file is specified the default
@@ -62,6 +63,11 @@ module Helix
       url      = add_sub_urls(base_url, opts)
     end
 
+    def clear_signatures!
+      @signature_for            = {}
+      @signature_expiration_for = {}
+    end
+
     # Creates the base url with information collected from credentials.
     #
     # @param [Hash] opts a hash of options for building URL

data/lib/helix/durationed_media.rb

@@ -0,0 +1,57 @@
+module Helix
+
+  module DurationedMedia
+
+    module ClassMethods
+
+      # Standard hash values used to generate the create_many
+      # url.
+      #
+      # @return [Hash]
+      def get_url_opts
+        { action:     :create_many,
+          media_type: plural_media_type,
+          format:     :xml }
+      end
+
+      private
+
+      # 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 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
+
+      # Gets the url used in the create_many import call.
+      #
+      # @return [String] Returns the valid url used for the API call.
+      def get_url
+        Helix::Config.instance.build_url(self.get_url_opts)
+      end
+
+      # 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 get_xml(attrs={})
+        return attrs[:use_raw_xml] if attrs[:use_raw_xml].present?
+        { list: { entry: attrs } }.to_xml(root: :add)
+      end
+
+    end
+
+    def self.included(klass); klass.extend(ClassMethods); end
+
+  end
+
+end

data/lib/helix/track.rb

@@ -2,6 +2,8 @@ module Helix
 
   class Track < Base
 
+    include DurationedMedia
+
     # The class name, to be used by supporting classes. Such as Config which uses
     # this method as a way to build URLs.
     #
@@ -11,7 +13,7 @@ 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
     #
@@ -25,54 +27,11 @@ module Helix
     # @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 }
+      RestClient.post(get_url,
+                      get_xml(attrs),
+                      get_params(attrs))
     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

@@ -5,6 +5,8 @@ module Helix
 
   class Video < Base
 
+    include DurationedMedia
+
     # The class name, to be used by supporting classes. Such as Config which uses
     # this method as a way to build URLs.
     #
@@ -27,53 +29,11 @@ module Helix
     # @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(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)
+      RestClient.post(get_url,
+                      get_xml(attrs),
+                      get_params(attrs))
     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/spec/config_spec.rb

@@ -237,6 +237,24 @@ describe Helix::Config do
     end
   end
 
+  describe "#clear_signatures!" do
+    let(:meth)  { :clear_signatures! }
+
+    subject     { obj.method(meth) }
+    its(:arity) { should eq(0) }
+
+    it "should set @signature_for to {}" do
+      obj.send(meth)
+      expect(obj.instance_variable_get(:@signature_for)).to eq({})
+    end
+
+    it "should set @signature_expiration_for to {}" do
+      obj.send(meth)
+      expect(obj.instance_variable_get(:@signature_expiration_for)).to eq({})
+    end
+
+  end
+
   describe "#existing_sig_for" do
     let(:meth)  { :existing_sig_for }
 
@@ -444,4 +462,13 @@ describe Helix::Config do
       end
     end
   end
+
+  [ :signature_for, :signature_expiration_for ].each do |meth|
+    describe "##{meth}" do
+      it "should respond to :#{meth}" do
+        expect(obj).to respond_to(meth)
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helix
 version: !ruby/object:Gem::Version
-  version: 0.0.1.5.pre
+  version: 0.0.1.6.pre
   prerelease: 8
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-07 00:00:00.000000000 Z
+date: 2012-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -48,7 +48,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.1.3
   type: :runtime
@@ -56,7 +56,7 @@ dependencies:
   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
@@ -69,6 +69,7 @@ files:
 - lib/helix/album.rb
 - lib/helix/base.rb
 - lib/helix/image.rb
+- lib/helix/durationed_media.rb
 - lib/helix/config.rb
 - lib/helix/video.rb
 - lib/helix/track.rb