rev-api 2.2.0 → 2.2.1

data/lib/rev-api/models/order.rb

@@ -1,138 +1,130 @@
-require 'rev-api/api_serializable'
-
-module Rev
-  # Represents Translation, Caption, or Transcription order.
-  # Should have TranslationInfo, CaptionInfo, or TranscriptionInfo, list
-  # of comments and attachments. Attributes names reflect
-  # API exposed names, but occasional hyphens are replaced
-  # with underscores
-  class Order < ApiSerializable
-    attr_reader :order_number, :price, :status, :attachments, :comments,
-      :translation, :transcription, :caption, :client_ref
-
-    # @param fields [Hash] hash of order fields parsed from JSON API response
-    def initialize(fields)
-      super fields
-      @attachments = fields['attachments'].map { |attachment_fields| Attachment.new(attachment_fields) }
-      @comments = fields['comments'].map { |comment_fields| Comment.new(comment_fields) }
-      @translation = TranslationInfo.new(fields['translation']) if fields['translation']
-      @transcription = TranscriptionInfo.new(fields['transcription']) if fields['transcription']
-      @caption = CaptionInfo.new(fields['caption']) if fields['caption']
-    end
-
-    # @return [Array of Attachment] with the kind of "transcript"
-    def transcripts
-      @attachments.select { |a| a.kind == Attachment::KINDS[:transcript]}
-    end
-
-    # @return [Array of Attachment] with the kind of "translation"
-    def translations
-      @attachments.select { |a| a.kind == Attachment::KINDS[:translation]}
-    end
-
-    # @return [Array of Attachment] with the kind of "caption"
-    def captions
-      @attachments.select { |a| a.kind == Attachment::KINDS[:caption] }
-    end
-
-    # @return [Array of Attachment] with the kind of "sources"
-    def sources
-      @attachments.select { |a| a.kind == Attachment::KINDS[:media]}
-    end
-  end
-
-  # Order comment, containing author, creation timestamp and text
-  class Comment < ApiSerializable
-    require 'date'
-
-    attr_reader :by, :timestamp, :text
-
-    # @param fields [Hash] hash of comment fields parsed from JSON API response
-    def initialize(fields)
-      super fields
-      @timestamp = Date.iso8601(fields['timestamp'])
-      @text = fields['text'] ? fields['text'] : String.new # right now API gives no 'text' field if text is empty
-    end
-  end
-
-  # Additional information specific to translation orders,
-  # such as word count, languages
-  class TranslationInfo < ApiSerializable
-    attr_reader :total_word_count, :source_language_code,
-      :destination_language_code
-  end
-
-  # Additional information specific to transcription orders,
-  # such as total length in minutes, verbatim and timestamps flags
-  class TranscriptionInfo < ApiSerializable
-    attr_reader :total_length_seconds, :verbatim, :timestamps
-    
-    # @deprecated use :total_length_seconds instead
-    attr_reader :total_length
-  end
-  
-  # Additional information specific to caption orders
-  class CaptionInfo < ApiSerializable
-    attr_reader :total_length_seconds
-    
-    # @deprecated use :total_length_seconds instead
-    attr_reader :total_length
-  end
-
-  # Represents order attachment - logical document associated with order
-  class Attachment < ApiSerializable
-    attr_reader :kind, :name, :id, :audio_length_seconds, :word_count, :links, :video_length_seconds
-    
-    KINDS = {
-      :transcript => 'transcript',
-      :translation => 'translation',
-      :caption => 'caption',
-      :media => 'media'
-    }
-
-    # List of supported mime-types used to request attachment's content
-    # within 'Accept' header
-    REPRESENTATIONS = {
-      # Supported by :transcript and :translation
-      :docx => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
-      :doc => 'application/msword',
-      :pdf => 'application/pdf',
-      :txt => 'text/plain',
-      :youtube => 'text/plain; format=youtube-transcript',
-      
-      # Supported by :caption
-      :srt => 'application/x-subrip',
-      :scc => 'text/x-scc',
-      :ttml => 'application/ttml+xml',
-      :qt => 'application/x-quicktime-timedtext'
-    }
-
-    # @param fields [Hash] fields of attachment fields parsed from JSON API response
-    def initialize(fields)
-      super fields
-      @links = fields['links'].map { |link_fields| Link.new(link_fields) }
-    end
-
-    # @param ext [Symbol] extension
-    # @return [String] mime-type for requested extension
-    def self.representation_mime(ext)
-      REPRESENTATIONS[ext]
-    end
-  end
-
-  # Link to actual file represented by attachment
-  class Link < ApiSerializable
-    attr_reader :rel, :href, :content_type
-  end
-
-  # Represents a paginated list of orders, including padination info.
-  class OrdersListPage < ApiSerializable
-    attr_reader :total_count, :results_per_page, :page, :orders
-
-    # @param fields [Hash] hash of OrdersListPage fields parsed from JSON API response
-    def initialize(fields)
-      super fields
-      @orders = fields['orders'].map { |order_fields| Order.new(order_fields) }
-    end
-  end
-end
+require 'rev-api/api_serializable'
+
+module Rev
+  # Represents a Caption or Transcription order.
+  # Should have CaptionInfo or TranscriptionInfo, list
+  # of comments and attachments. Attributes names reflect
+  # API exposed names, but occasional hyphens are replaced
+  # with underscores
+  class Order < ApiSerializable
+    attr_reader :order_number, :price, :status, :attachments, :comments,
+      :transcription, :caption, :client_ref
+
+    # @param fields [Hash] hash of order fields parsed from JSON API response
+    def initialize(fields)
+      super fields
+      @attachments = fields['attachments'].map { |attachment_fields| Attachment.new(attachment_fields) }
+      @comments = fields['comments'].map { |comment_fields| Comment.new(comment_fields) }
+      @transcription = TranscriptionInfo.new(fields['transcription']) if fields['transcription']
+      @caption = CaptionInfo.new(fields['caption']) if fields['caption']
+    end
+
+    # @return [Array of Attachment] with the kind of "transcript"
+    def transcripts
+      @attachments.select { |a| a.kind == Attachment::KINDS[:transcript]}
+    end
+
+    # @return [Array of Attachment] with the kind of "caption"
+    def captions
+      @attachments.select { |a| a.kind == Attachment::KINDS[:caption] }
+    end
+
+    # @return [Array of Attachment] with the kind of "sources"
+    def sources
+      @attachments.select { |a| a.kind == Attachment::KINDS[:media]}
+    end
+  end
+
+  # Order comment, containing author, creation timestamp and text
+  class Comment < ApiSerializable
+    require 'date'
+
+    attr_reader :by, :timestamp, :text
+
+    # @param fields [Hash] hash of comment fields parsed from JSON API response
+    def initialize(fields)
+      super fields
+      @timestamp = Date.iso8601(fields['timestamp'])
+      @text = fields['text'] ? fields['text'] : String.new # right now API gives no 'text' field if text is empty
+    end
+  end
+
+  # Additional information specific to transcription orders,
+  # such as total length in minutes, verbatim and timestamps flags
+  class TranscriptionInfo < ApiSerializable
+    attr_reader :total_length_seconds, :verbatim, :timestamps
+
+    # @deprecated use :total_length_seconds instead
+    attr_reader :total_length
+  end
+
+  # Additional information specific to caption orders
+  class CaptionInfo < ApiSerializable
+    attr_reader :total_length_seconds
+
+    # @deprecated use :total_length_seconds instead
+    attr_reader :total_length
+  end
+
+  # Represents order attachment - logical document associated with order
+  class Attachment < ApiSerializable
+    attr_reader :kind, :name, :id, :audio_length_seconds, :links, :video_length_seconds
+
+    KINDS = {
+      :transcript => 'transcript',
+      :caption => 'caption',
+      :media => 'media'
+    }
+
+    # List of supported mime-types used to request attachment's content
+    # within 'Accept' header
+    REPRESENTATIONS = {
+      # Supported by :transcript
+      :docx => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+      :doc => 'application/msword',
+      :pdf => 'application/pdf',
+      :txt => 'text/plain',
+      :youtube => 'text/plain; format=youtube-transcript',
+
+      # Supported by :caption
+      :srt => 'application/x-subrip',
+      :scc => 'text/x-scc',
+      :mcc => 'text/x-mcc',
+      :ttml => 'application/ttml+xml',
+      :qt => 'application/x-quicktime-timedtext',
+      :vtt => 'text/vtt',
+      :dfxp => 'application/ttaf+xml',
+      :cap => 'application/x-cheetah-cap',
+      :stl => 'text/x-stl',
+      :avidds => 'text/vnd.avid-ds'
+    }
+
+    # @param fields [Hash] fields of attachment fields parsed from JSON API response
+    def initialize(fields)
+      super fields
+      @links = fields['links'].map { |link_fields| Link.new(link_fields) }
+    end
+
+    # @param ext [Symbol] extension
+    # @return [String] mime-type for requested extension
+    def self.representation_mime(ext)
+      REPRESENTATIONS[ext]
+    end
+  end
+
+  # Link to actual file represented by attachment
+  class Link < ApiSerializable
+    attr_reader :rel, :href, :content_type
+  end
+
+  # Represents a paginated list of orders, including padination info.
+  class OrdersListPage < ApiSerializable
+    attr_reader :total_count, :results_per_page, :page, :orders
+
+    # @param fields [Hash] hash of OrdersListPage fields parsed from JSON API response
+    def initialize(fields)
+      super fields
+      @orders = fields['orders'].map { |order_fields| Order.new(order_fields) }
+    end
+  end
+end

data/lib/rev-api/models/order_request.rb

@@ -1,222 +1,194 @@
-require 'rev-api/api_serializable'
-
-module Rev
-  # OrderRequest is used for constructing order 'spec' in consumer code and passing it into.
-  # It consists of three main elements: :payment, :transcription_options and :notification.
-  # You can also supply reference number, customer comment, and whether standard turnaround time is not required
-  #
-  # @note https://www.rev.com/api/ordersposttranscription, https://www.rev.com/api/ordersposttranslation, https://www.rev.com/api/orderspostcaption
-  class OrderRequest < ApiSerializable
-    # see {Rev::Payment}
-    attr_reader :payment
-
-    # see {Rev::TranscriptionOptions}
-    attr_reader :transcription_options
-
-    # see {Rev::TranslationOptions}
-    attr_reader :translation_options
-
-    # see {Rev::CaptionOptions}
-    attr_reader :caption_options
-
-    # see {Rev::Notification}
-    attr_reader :notification
-
-    # a reference number for the order meaningful for the client (optional)
-    attr_reader :client_ref
-
-    # a comment with any special messages about the order (optional)
-    attr_reader :comment
-
-    # a boolean flag specifying whether normal turnaround time is not required, defaults to false (optional)
-    attr_reader :non_standard_tat_guarantee
-
-    # @param payment [Payment] payment info
-    # @param fields [Hash] of fields to initialize instance. See instance attributes for available fields.
-    # @deprecated payment always defaults to :account_balance
-    def self.new_with_payment(payment, fields = {})
-      fields = { :non_standard_tat_guarantee => false }.merge(fields)
-      super fields
-      @payment = payment
-    end
-
-    # @param fields [Hash] of fields to initialize instance. See instance attributes for available fields.
-    def initialize(fields = {})
-      fields = { :non_standard_tat_guarantee => false }.merge(fields)
-      @payment = Rev::Payment.with_account_balance
-      super fields
-    end
-  end
-
-  # Payment Info. Payment can only be done by debiting the user's account balance.
-  # @deprecated setting the payment is no longer necessary. All orders now default to :account_balance
-  class Payment < ApiSerializable
-    attr_accessor :type
-
-    # use to correctly set payment type
-    TYPES = {
-      :account_balance => 'AccountBalance'
-    }
-
-    CC_ON_FILE_ID = 1
-
-    # @param type [String] payment method
-    def initialize(type)
-      @type = type
-    end
-
-    class << self
-      def with_account_balance()
-        Payment::new(TYPES[:account_balance])
-      end
-    end
-  end
-
-  # Billing address
-  class BillingAddress < ApiSerializable
-    attr_reader :street, :street2, :city, :state, :zip, :country_alpha2
-  end
-
-  # Superclass for the business-line options that handles capture and common validation of inputs.
-  class InputOptions < ApiSerializable
-    # Mandatory, contains list of inputs. Must have at least one element.
-    attr_reader :inputs
-
-    # @param inputs [Array] list of inputs
-    # @param info [Hash] of fields to initialize instance.
-    def initialize(inputs, info = {})
-      super info
-      raise(ArgumentError, "inputs must have at least one element") unless validate_inputs(inputs)
-      @inputs = inputs
-    end
-
-    private
-
-    def validate_inputs(inputs)
-      !inputs.nil? && inputs.length > 0
-    end
-  end
-
-  # Transcription options. This section contains the input media that must be transferred to our servers
-  # using a POST to /inputs, and are referenced using the URIs returned by that call. We also support external links.
-  # @see https://www.rev.com/api/ordersposttranscription
-  class TranscriptionOptions < InputOptions
-    # Optional, should we transcribe the provided files verbatim? If true,
-    # all filler words (i.e. umm, huh) will be included.
-    attr_reader :verbatim
-
-    # Optional, should we include timestamps?
-    attr_reader :timestamps
-
-    # @param inputs [Array] list of inputs
-    # @param info [Hash] of fields to initialize instance. May contain:
-    #        - :verbatim => true/false
-    #        - :timestamps => true/false
-    def initialize(inputs, info = {})
-      super inputs, info
-    end
-  end
-
-  # Translation options. This section contains the input media that must be transferred to our
-  # servers using a POST to /inputs, and are referenced using the URIs returned by that call.
-  # For each media, word count must be specified. The language code for the source and desitination
-  # languages must also be specified.
-  # @see https://www.rev.com/api/ordersposttranslation
-  class TranslationOptions < InputOptions
-    # Mandatory, source language code
-    attr_reader :source_language_code
-
-    # Mandatory, destination language code
-    attr_reader :destination_language_code
-
-    # @param inputs [Array] list of inputs
-    # @param info [Hash] of fields to initialize instance. May contain:
-    #        - :source_language_code
-    #        - :destination_language_code
-    # @note For language codes refer to http://www.loc.gov/standards/iso639-2/php/code_list.php
-    def initialize(inputs, info = {})
-      super inputs, info
-    end
-  end
-
-  # Caption options. This section contains the input media that must be transferred to our servers
-  # using a POST to /inputs, and are referenced using the URIs returned by that call. We also support external links.
-  # @see https://www.rev.com/api/orderspostcaption
-  class CaptionOptions < InputOptions
-    # Array of file formats the captions should be delivered as.  (Optional, default is SubRip)
-    attr_reader :output_file_formats
-
-    # Optional, Array of language codes to request foreign language subtitles
-    attr_reader :subtitle_languages
-
-    # All supported output file formats
-    OUTPUT_FILE_FORMATS = {
-      :subrip => 'SubRip',
-      :scc => 'Scc',
-      :mcc => 'Mcc',
-      :ttml => 'Ttml',
-      :qttext => 'QTtext',
-      :transcript => 'Transcript',
-      :webvtt => 'WebVtt',
-      :dfxp => 'Dfxp',
-      :cheetahcap => 'CheetahCap'
-    }
-
-    # @param inputs [Array] list of inputs
-    # @param info [Hash] of fields to initialize instance. May contain:
-    #        - :subtitle_languages
-    # @see TranslationOptions for a list of language codes.
-    def initialize(inputs, info = {})
-      super(inputs, info)
-      raise(ArgumentError, "invalid format(s)") unless validate_output_formats(info[:output_file_formats])
-    end
-
-    private
-
-    def validate_output_formats(formats)
-      formats.nil? || formats.select{|f| !OUTPUT_FILE_FORMATS.has_value?(f) }.empty?
-    end
-  end
-
-  # Input for order (aka source file)
-  class Input < ApiSerializable
-    #  Mandatory when used with {Rev::OrderRequest::TranslationInfo}, length of document, in words
-    attr_reader :word_length
-
-    # Length of audio in seconds (mandatory in case of inability to determine it automatically).
-    # Used within {Rev::OrderRequest::TranscriptionInfo}
-    attr_reader :audio_length_seconds
-
-    # Length of video in seconds (mandatory in case of inability to determine it automatically).
-    # Used within {Rev::OrderRequest::CaptionInfo}
-    attr_reader :video_length_seconds
-
-    # Mandatory, URI of the media, as returned from the call to POST /inputs.
-    # :external_link might substitute :uri for Transcription or Caption.
-    attr_reader :uri
-
-    # External URL, if sources wasn't POSTed as input (YouTube, Vimeo, Dropbox, etc)
-    attr_reader :external_link
-  end
-
-  # Notification Info. Optionally you may request that an HTTP post be made to a url of your choice when the order enters
-  # a new status (eg being transcribed or reviewed) and when it is complete.
-  class Notification < ApiSerializable
-    attr_reader :url, :level
-
-    # Notification levels
-    LEVELS = {
-      :detailed => 'Detailed',
-      :final_only => 'FinalOnly'
-    }
-
-    # @param url [String] The url for notifications. Mandatory if the notifications element is used. Updates will be posted to this URL
-    # @param level [String] Optional, specifies which notifications are sent:
-    #        - :detailed - a notification is sent whenever the order is in a new status or has a new comment
-    #        - :final_only - (the default), notification is sent only when the order is complete
-    def initialize(url, level = nil)
-      @url = url
-      @level = level ? level : LEVELS[:final_only]
-    end
-  end
-end
+require 'rev-api/api_serializable'
+
+module Rev
+  # OrderRequest is used for constructing order 'spec' in consumer code and passing it into.
+  # It consists of three main elements: :payment, :transcription_options and :notification.
+  # You can also supply reference number, customer comment, and whether standard turnaround time is not required
+  #
+  # @note https://www.rev.com/api/ordersposttranscription, https://www.rev.com/api/orderspostcaption
+  class OrderRequest < ApiSerializable
+    # see {Rev::Payment}
+    attr_reader :payment
+
+    # see {Rev::TranscriptionOptions}
+    attr_reader :transcription_options
+
+    # see {Rev::CaptionOptions}
+    attr_reader :caption_options
+
+    # see {Rev::Notification}
+    attr_reader :notification
+
+    # a reference number for the order meaningful for the client (optional)
+    attr_reader :client_ref
+
+    # a comment with any special messages about the order (optional)
+    attr_reader :comment
+
+    # a boolean flag specifying whether normal turnaround time is not required, defaults to false (optional)
+    attr_reader :non_standard_tat_guarantee
+
+    # @param payment [Payment] payment info
+    # @param fields [Hash] of fields to initialize instance. See instance attributes for available fields.
+    # @deprecated payment always defaults to :account_balance
+    def self.new_with_payment(payment, fields = {})
+      fields = { :non_standard_tat_guarantee => false }.merge(fields)
+      super fields
+      @payment = payment
+    end
+
+    # @param fields [Hash] of fields to initialize instance. See instance attributes for available fields.
+    def initialize(fields = {})
+      fields = { :non_standard_tat_guarantee => false }.merge(fields)
+      @payment = Rev::Payment.with_account_balance
+      super fields
+    end
+  end
+
+  # Payment Info. Payment can only be done by debiting the user's account balance.
+  # @deprecated setting the payment is no longer necessary. All orders now default to :account_balance
+  class Payment < ApiSerializable
+    attr_accessor :type
+
+    # use to correctly set payment type
+    TYPES = {
+      :account_balance => 'AccountBalance'
+    }
+
+    CC_ON_FILE_ID = 1
+
+    # @param type [String] payment method
+    def initialize(type)
+      @type = type
+    end
+
+    class << self
+      def with_account_balance()
+        Payment::new(TYPES[:account_balance])
+      end
+    end
+  end
+
+  # Billing address
+  class BillingAddress < ApiSerializable
+    attr_reader :street, :street2, :city, :state, :zip, :country_alpha2
+  end
+
+  # Superclass for the business-line options that handles capture and common validation of inputs.
+  class InputOptions < ApiSerializable
+    # Mandatory, contains list of inputs. Must have at least one element.
+    attr_reader :inputs
+
+    # @param inputs [Array] list of inputs
+    # @param info [Hash] of fields to initialize instance.
+    def initialize(inputs, info = {})
+      super info
+      raise(ArgumentError, "inputs must have at least one element") unless validate_inputs(inputs)
+      @inputs = inputs
+    end
+
+    private
+
+    def validate_inputs(inputs)
+      !inputs.nil? && inputs.length > 0
+    end
+  end
+
+  # Transcription options. This section contains the input media that must be transferred to our servers
+  # using a POST to /inputs, and are referenced using the URIs returned by that call. We also support external links.
+  # @see https://www.rev.com/api/ordersposttranscription
+  class TranscriptionOptions < InputOptions
+    # Optional, should we transcribe the provided files verbatim? If true,
+    # all filler words (i.e. umm, huh) will be included.
+    attr_reader :verbatim
+
+    # Optional, should we include timestamps?
+    attr_reader :timestamps
+
+    # @param inputs [Array] list of inputs
+    # @param info [Hash] of fields to initialize instance. May contain:
+    #        - :verbatim => true/false
+    #        - :timestamps => true/false
+    def initialize(inputs, info = {})
+      super inputs, info
+    end
+  end
+
+  # Caption options. This section contains the input media that must be transferred to our servers
+  # using a POST to /inputs, and are referenced using the URIs returned by that call. We also support external links.
+  # @see https://www.rev.com/api/orderspostcaption
+  class CaptionOptions < InputOptions
+    # Array of file formats the captions should be delivered as.  (Optional, default is SubRip)
+    attr_reader :output_file_formats
+
+    # Optional, Array of language codes to request foreign language subtitles
+    attr_reader :subtitle_languages
+
+    # All supported output file formats
+    OUTPUT_FILE_FORMATS = {
+      :subrip => 'SubRip',
+      :scc => 'Scc',
+      :mcc => 'Mcc',
+      :ttml => 'Ttml',
+      :qttext => 'QTtext',
+      :transcript => 'Transcript',
+      :webvtt => 'WebVtt',
+      :dfxp => 'Dfxp',
+      :cheetahcap => 'CheetahCap'
+    }
+
+    # @param inputs [Array] list of inputs
+    # @param info [Hash] of fields to initialize instance. May contain:
+    #        - :subtitle_languages
+    # @see For language codes refer to http://www.loc.gov/standards/iso639-2/php/code_list.php
+    def initialize(inputs, info = {})
+      super(inputs, info)
+      raise(ArgumentError, "invalid format(s)") unless validate_output_formats(info[:output_file_formats])
+    end
+
+    private
+
+    def validate_output_formats(formats)
+      formats.nil? || formats.select{|f| !OUTPUT_FILE_FORMATS.has_value?(f) }.empty?
+    end
+  end
+
+  # Input for order (aka source file)
+  class Input < ApiSerializable
+    # Length of audio in seconds (mandatory in case of inability to determine it automatically).
+    # Used within {Rev::OrderRequest::TranscriptionInfo}
+    attr_reader :audio_length_seconds
+
+    # Length of video in seconds (mandatory in case of inability to determine it automatically).
+    # Used within {Rev::OrderRequest::CaptionInfo}
+    attr_reader :video_length_seconds
+
+    # Mandatory, URI of the media, as returned from the call to POST /inputs.
+    # :external_link might substitute :uri for Transcription or Caption.
+    attr_reader :uri
+
+    # External URL, if sources wasn't POSTed as input (YouTube, Vimeo, Dropbox, etc)
+    attr_reader :external_link
+  end
+
+  # Notification Info. Optionally you may request that an HTTP post be made to a url of your choice when the order enters
+  # a new status (eg being transcribed or reviewed) and when it is complete.
+  class Notification < ApiSerializable
+    attr_reader :url, :level
+
+    # Notification levels
+    LEVELS = {
+      :detailed => 'Detailed',
+      :final_only => 'FinalOnly'
+    }
+
+    # @param url [String] The url for notifications. Mandatory if the notifications element is used. Updates will be posted to this URL
+    # @param level [String] Optional, specifies which notifications are sent:
+    #        - :detailed - a notification is sent whenever the order is in a new status or has a new comment
+    #        - :final_only - (the default), notification is sent only when the order is complete
+    def initialize(url, level = nil)
+      @url = url
+      @level = level ? level : LEVELS[:final_only]
+    end
+  end
+end