helix 0.0.2.7.pre → 0.0.2.8.pre

data/README.md

@@ -44,11 +44,10 @@ rake reinstall_helix_rvm
 
 Using gem in a Gemfile  
 ```shell
-gem 'helix', :git => git@github.com:Twistage/helix.git
+gem 'helix', :git => 'git@github.com:Twistage/helix.git'
 ```
 
 
-
 Supported Ruby versions
 -----------------------
 
@@ -57,88 +56,26 @@ Supported Ruby versions
 
 How To
 ------
-Warning: How To is not currently finished, it may be inaccurate. 
 ###Setup YAML
 ```yaml
 site: 'http://service.twistage.com'
-user: 'my_account@twistage.com'
-password: 'password123'
 company: 'my_company'
-license_key: '141a86b5c4091
+license_key: '141a86b5c4091'
+library_id: 'development'
+```
+Boot up IRB in your console
+```shell
+irb
 ```
 Load the YAML file as your config.
 ```ruby
+require 'helix'
 Helix::Config.load("path/to/yaml.yml")
+videos = Helix::Video.find_all
 ```
-####Current CRUD methods supported by all models
-.create  
-.find  
-\#update  
-\#destroy  
 
-####Current models
-Videos, Images, Albums, Tracks, Playlists
+If no file is passed in Helix with default to './helix.yml'
 
-###Videos
-#####Required fields: title, description, library, company, and source.
-```ruby
-video = Helix::Video.create!( title:       'New Video', 
-                              description: 'A video of new things', 
-                              source:      'http://somesource.com/source.mp4'
-                              company:     'some_company',
-                              library:     'some_library')
-video.update({title: "New Title"})
-another_video = Helix::Video.find(some_guid)
-another_video.destroy
-```
-###Albums
-#####Required fields: title, library, company.
-```ruby
-album = Helix::Album.create!( title:       'New Album', 
-                              description: 'A album of new things', 
-                              source:      'http://somesource.com/source.mp4'
-                              company:     'some_company',
-                              library:     'some_library')
-#Update for album is not currently supported
-another_album = Helix::Album.find(some_guid)
-another_album.destroy
-```
-###Images
-#####Required fields: title, description, library, company, and source.
-```ruby
-image = Helix::Image.create!( title:       'New Image', 
-                              description: 'A image of new things', 
-                              source:      'http://somesource.com/source.jpg'
-                              company:     'some_company',
-                              library:     'some_library')
-image.update({title: "New Title"})
-another_image = Helix::Image.find(some_guid)
-another_image.destroy
-```
-###Tracks
-#####Required fields: title, description, library, company, and source.
-```ruby
-track = Helix::Track.create!( title:       'New Track', 
-                              description: 'A track of new things', 
-                              source:      'http://somesource.com/source.mp3'
-                              company:     'some_company',
-                              library:     'some_library')
-track.update({title: "New Title"})
-another_track = Helix::Track.find(some_guid)
-another_track.destroy
-```
-###Playlists
-#####Required fields: title, library, company.
-```ruby
-playlist = Helix::Playlist.create!( title:       'New Playlist', 
-                                    description: 'A playlist of new things', 
-                                    source:      'http://somesource.com/source.mp4'
-                                    company:     'some_company',
-                                    library:     'some_library')
-playlist.update({title: "New Title"})
-another_playlist = Helix::Playlist.find(some_guid)
-another_playlist.destroy
-```
 
 More Information
 ----------------
@@ -163,4 +100,4 @@ 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.rb

@@ -1,3 +1,5 @@
+require 'helix/restful'
+require 'helix/uploadable'
 require 'helix/durationed_media'
 require 'helix/video'
 require 'helix/track'

data/lib/helix/album.rb

@@ -24,7 +24,7 @@ module Helix
 
     def self.known_attributes
       [:title, :description]
-    end 
+    end
 
   end
 

data/lib/helix/base.rb

@@ -3,6 +3,7 @@ require 'json'
 require 'yaml'
 require 'nori'
 require 'time'
+require 'helix/exceptions'
 
 module Helix
   class Base
@@ -23,6 +24,7 @@ module Helix
     # @param [Hash] opts a hash of options for parameters passed into the HTTP GET
     # @return [Array] The array of instance objects for a class.
     def self.find_all(original_opts={})
+      raise Helix::NoConfigurationLoaded.new if config.nil?
       opts           = original_opts.clone
       RestClient.log = 'helix.log' if opts.delete(:log)
       data_sets = get_data_sets(opts)
@@ -49,11 +51,11 @@ module Helix
     # @param [Hash] opts a hash of options for parameters passed into the HTTP GET
     # @return [Array] The array of attributes (for a model) in hash form.
     def self.get_data_sets(opts)
+      label        = self.plural_resource_label
       url          = config.build_url(content_type:   opts[:content_type] || :xml,
-                                      resource_label: self.plural_resource_label)
+                                      resource_label: label)
       # We allow opts[:sig_type] for internal negative testing only.
-      raw_response = config.get_response(url, {sig_type: :view}.merge(opts))
-      data_sets    = raw_response[plural_resource_label]
+      data_sets    = config.get_aggregated_data_sets(url, label, {sig_type: :view}.merge(opts))
     end
 
     # Creates a string that associates to the class id.
@@ -120,6 +122,14 @@ module Helix
     end
     alias_method :reload, :load
 
+    def to_json
+      {resource_label_sym => @attributes}.to_json
+    end
+
+    def to_xml
+      modified_attributes.to_xml({root: resource_label_sym})
+    end
+
     # Raises an error for missing method calls.
     #
     # @param [Symbol] method_sym The method attempting to be called.
@@ -171,6 +181,16 @@ module Helix
       attrs.merge({'custom_fields' => cfs})
     end
 
+    def modified_attributes
+      custom_fields = @attributes['custom_fields']
+      return @attributes if custom_fields.nil?
+      return @attributes if custom_fields.first['name'].nil?
+      new_cfs = custom_fields.inject({}) do |memo,cf|
+        memo.merge(cf['name'] => cf['value'])
+      end
+      @attributes.merge('custom_fields' => new_cfs)
+    end
+
     def self.resource_label_sym
       to_s.split('::').last.singularize.downcase.to_sym
     end

data/lib/helix/config.rb

@@ -12,14 +12,16 @@ module Helix
 
     unless defined?(self::DEFAULT_FILENAME)
       DEFAULT_FILENAME = './helix.yml'
+      ITEMS_PER_PAGE   = 100
       SCOPES           = [:reseller, :company, :library]
       SIG_DURATION     = 1200 # in minutes
+      STARTING_PAGE    = 1
       TIME_OFFSET      = 1000 * 60 # 1000 minutes, lower to give some margin of error
       VALID_SIG_TYPES  = [ :ingest, :update, :view ]
     end
 
     attr_accessor :credentials
-    attr_reader   :signature_for, :signature_expiration_for
+    attr_reader   :response, :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
@@ -72,6 +74,25 @@ module Helix
       @signature_expiration_for = {}
     end
 
+    # Makes aggregated calls to get_response with pagination
+    # folding/injecting/accumulating the results into a single output set.
+    #
+    # @param [String] url the base part of the URL to be used
+    # @param [String] plural_resource_label: "videos", "tracks", etc.
+    # @param [Hash] original_opts a hash of options for building URL additions
+    # @return [Array] The accumulated attribute Hashes for ORM instances
+    def get_aggregated_data_sets(url, plural_resource_label, original_opts={})
+      data_sets, page, per_page = [], STARTING_PAGE
+      until last_page?
+        aggregation_opts = original_opts.merge(page: page, per_page: ITEMS_PER_PAGE)
+        raw_response = get_response(url, {sig_type: :view}.merge(aggregation_opts))
+        data_set     = raw_response[plural_resource_label]
+        data_sets   += data_set if data_set
+        page        += 1
+      end
+      data_sets
+    end
+
     # Creates the base url with information collected from credentials.
     #
     # @param [Hash] opts a hash of options for building URL
@@ -93,19 +114,31 @@ module Helix
     # with the base_url to create RESTful URLs
     #
     # @param [String] url the base part of the URL to be used
-    # @param [Hash] opts a hash of options for building URL additions
+    # @param [Hash] original_opts a hash of options for building URL additions
     # @return [String] The full RESTful URL string object
     def get_response(url, original_opts={})
       opts        = original_opts.clone
       sig_type    = opts.delete(:sig_type)
       params      = opts.merge(signature: signature(sig_type, opts))
-      response    = RestClient.get(url, params: params)
-      parse_response_by_url_format(response, url)
+      @response   = RestClient.get(url, params: params)
+      parse_response_by_url_format(@response, url)
+    end
+
+    # Reports whether the most recent response's headers have a true :is_last_page value
+    #
+    # @return [Boolean] As above. Returns false if no such header is found,
+    # or if there is an explictly false value.
+    def last_page?
+      return false unless @response
+      return false unless @response.headers
+      @response.headers.has_key?(:is_last_page) and
+        @response.headers[:is_last_page] == "true"
     end
 
     # Fetches the signature for a specific license key.
     #
     # @param [Symbol] sig_type The type of signature required for calls.
+    # @param [Hash] opts allows you to overide contributor and license_id
     # @return [String] The signature needed to pass around for calls.
     def signature(sig_type, opts={})
       prepare_signature_memoization
@@ -181,6 +214,7 @@ module Helix
 
     def url_for(sig_type, opts={})
       contributor, library_id = [:contributor, :library_id].map { |key| opts[key] }
+      contributor ||= credentials[:contributor]
       url  = "#{credentials[:site]}/api/#{sig_type}_key?licenseKey=#{credentials[:license_key]}&duration=#{SIG_DURATION}"
       url += "&contributor=#{contributor}"  if contributor
       url += "&library_id=#{library_id}"    if library_id

data/lib/helix/durationed_media.rb

@@ -5,8 +5,8 @@ module Helix
     module ClassMethods
 
       # Used to import tracks from a URL into the Twistage system.
-      # Doc reference: /doc/api/track/import
-      # Doc reference: /doc/api/video/import
+      # API doc reference: /doc/api/track/import
+      # API doc reference: /doc/api/video/import
       #
       # @example
       #   track = Helix::Track.import(src:          "www.google.com/track.mp4",
@@ -62,9 +62,9 @@ module Helix
       end
 
       def rest_post(api_call, attrs)
-        RestClient.log        = 'helix.log' if attrs.delete(:log)
-        content_type          = url_opts_for[api_call][:content_type]
-        content_type_hash     = { content_type: "text/#{content_type}" }
+        RestClient.log    = 'helix.log' if attrs.delete(:log)
+        content_type      = url_opts_for[api_call][:content_type]
+        content_type_hash = { content_type: "text/#{content_type}" }
         RestClient.post(get_url_for(api_call, attrs),
                         get_xml(attrs),
                         get_params(attrs).merge(content_type_hash))

data/lib/helix/library.rb

@@ -2,7 +2,9 @@ require 'helix/media'
 
 module Helix
 
-  class Library < Media
+  class Library < Base
+
+    include RESTful
 
     # The class name, to be used by supporting classes. Such as Config which uses
     # this method as a way to build URLs.

data/lib/helix/media.rb

@@ -1,70 +1,11 @@
 require 'helix/base'
 
 module Helix
-  class Media < Base
-    # Creates a new record via API and then returns an instance of that record.
-    #
-    # Example is using Video class since Video inherits from Base. This won't
-    # normally be called as Helix::Base.create
-    #
-    # @example
-    #   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={})
-      url       = config.build_url(resource_label: plural_resource_label,
-                                   content_type:   :xml)
-      response  = RestClient.post(url, attributes.merge(signature: config.signature(:update)))
-      attrs     = Hash.from_xml(response)
-      self.new(attributes: attrs[resource_label_sym.to_s], config: config)
-    end
 
-    # Finds and returns a record in instance form for a class, through
-    # guid lookup.
-    #
-    # @example
-    #   video_guid  = "8e0701c142ab1"
-    #   video       = Helix::Video.find(video_guid)
-    #
-    # @param [String] guid an id in guid form.
-    # @return [Base] An instance of Helix::Base
-    def self.find(guid)
-      raise ArgumentError.new("find requires a non-nil guid argument - received a nil argument.") if guid.nil?
-      item   = self.new(attributes: { guid_name => guid }, config: config)
-      item.load
-    end
+  class Media < Base
 
-    # Deletes the record of the Helix::Base instance.
-    #
-    # @example
-    #   video = Helix::Video.create({title: "Some Title"})
-    #   video.destroy
-    #
-    # @return [String] The response from the HTTP DELETE call.
-    def destroy
-      url      = config.build_url(content_type: :xml, guid: guid, resource_label: plural_resource_label)
-      RestClient.delete(url, params: {signature: config.signature(:update)})
-    end
+    include RESTful, Uploadable
 
-    # Updates instance and record with attributes passed in.
-    #
-    # @example
-    #   video = Helix::Video.find(video_guid)
-    #   video.update({title: "My new title"})
-    #
-    # @param [Hash] opts a hash of attributes to update the instance with.
-    # @return [Base] Returns an instance of the class after update.
-    def update(original_opts={})
-      opts           = original_opts.clone
-      RestClient.log = 'helix.log' if opts.delete(:log)
-      memo_cfg = config
-      url      = memo_cfg.build_url(content_type:   :xml,
-                                    guid:           guid,
-                                    resource_label: plural_resource_label)
-      params   = {signature: memo_cfg.signature(:update)}.merge(resource_label_sym => opts)
-      RestClient.put(url, params)
-      self
-    end
   end
+
 end

data/lib/helix/restful.rb

@@ -0,0 +1,89 @@
+module Helix
+
+  # Mixed-in to ORM classes to provide basic RESTful CRUD operations.
+
+  module RESTful
+
+    # Deletes the record of the Helix::Base instance.
+    #
+    # @example
+    #   video = Helix::Video.create({title: "Some Title"})
+    #   video.destroy
+    #
+    # @return [String] The response from the HTTP DELETE call.
+    def destroy
+      url = config.build_url(build_url_opts)
+      RestClient.delete(url, params: {signature: config.signature(:update)})
+    end
+
+    # Updates instance and record with attributes passed in.
+    #
+    # @example
+    #   video = Helix::Video.find(video_guid)
+    #   video.update({title: "My new title"})
+    #
+    # @param [Hash] opts a hash of attributes to update the instance with.
+    # @return [Base] Returns an instance of the class after update.
+    def update(original_opts={})
+      opts           = original_opts.clone
+      RestClient.log = 'helix.log' if opts.delete(:log)
+      memo_cfg = config
+      url      = memo_cfg.build_url(build_url_opts)
+      params   = {signature: memo_cfg.signature(:update)}.merge(resource_label_sym => opts)
+      RestClient.put(url, params)
+      self
+    end
+
+    private
+
+    def build_url_opts
+      self.class.build_url_opts.merge({guid: guid, resource_label: plural_resource_label})
+    end
+
+    module ClassMethods
+
+      # Creates a new record via API and then returns an instance of that record.
+      #
+      # Example is using Video class since Video inherits from Base. This won't
+      # normally be called as Helix::Base.create
+      #
+      # @example
+      #   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 create(attributes={})
+        raise Helix::NoConfigurationLoaded.new if config.nil?
+        url       = config.build_url(build_url_opts)
+        response  = RestClient.post(url, attributes.merge(signature: config.signature(:update)))
+        attrs     = Hash.from_xml(response)
+        self.new(attributes: attrs[resource_label_sym.to_s], config: config)
+      end
+
+      # Finds and returns a record in instance form for a class, through
+      # guid lookup.
+      #
+      # @example
+      #   video_guid  = "8e0701c142ab1"
+      #   video       = Helix::Video.find(video_guid)
+      #
+      # @param [String] guid an id in guid form.
+      # @return [Base] An instance of Helix::Base
+      def find(guid)
+        raise ArgumentError.new("find requires a non-nil guid argument - received a nil argument.") if guid.nil?
+        raise Helix::NoConfigurationLoaded.new if config.nil?
+        item   = self.new(attributes: { guid_name => guid }, config: config)
+        item.load
+      end
+
+      def build_url_opts
+        {content_type: :xml, resource_label: plural_resource_label}
+      end
+
+    end
+
+    def self.included(klass); klass.extend(ClassMethods); end
+
+  end
+
+end