rev-api 2.1.0 → 2.2.0

data/lib/rev-api/api_serializable.rb

@@ -1,30 +1,30 @@
-module Rev
-  # Utility class with instance methods for hash/JSON conversion
-  class ApiSerializable
-
-    # Map given hash to instance properties
-    #
-    # @param fields [Hash] of fields to initialize instance. See instance attributes for available fields.
-    def initialize(fields = {})
-      fields.each { |k,v| self.instance_variable_set("@#{k.to_sym}", v) if self.methods.include? k.to_sym }
-    end
-
-    # Recursively convert object to hash
-    # @note http://stackoverflow.com/questions/1684588/how-to-do-ruby-object-serialization-using-json
-    #
-    # @return [Hash] hash map of the object including all nested children
-    def to_hash
-      h = {}
-      instance_variables.each do |e|
-        o = instance_variable_get e.to_sym
-        h[e[1..-1]] = (o.respond_to? :to_hash) ? o.to_hash : o;
-      end
-      h
-    end
-
-    # Recursively convert object to JSON (internally utilizing hash)
-    def to_json *args
-      to_hash.to_json *args
-    end
-  end
-end
+module Rev
+  # Utility class with instance methods for hash/JSON conversion
+  class ApiSerializable
+
+    # Map given hash to instance properties
+    #
+    # @param fields [Hash] of fields to initialize instance. See instance attributes for available fields.
+    def initialize(fields = {})
+      fields.each { |k,v| self.instance_variable_set("@#{k.to_sym}", v) if self.methods.include? k.to_sym }
+    end
+
+    # Recursively convert object to hash
+    # @note http://stackoverflow.com/questions/1684588/how-to-do-ruby-object-serialization-using-json
+    #
+    # @return [Hash] hash map of the object including all nested children
+    def to_hash
+      h = {}
+      instance_variables.each do |e|
+        o = instance_variable_get e.to_sym
+        h[e[1..-1]] = (o.respond_to? :to_hash) ? o.to_hash : o;
+      end
+      h
+    end
+
+    # Recursively convert object to JSON (internally utilizing hash)
+    def to_json *args
+      to_hash.to_json *args
+    end
+  end
+end

data/lib/rev-api/exceptions.rb

@@ -1,100 +1,100 @@
-module Rev
-  class ApiError < StandardError; end
-
-  # 400 BadRequest. Response body contains API error code and optional details
-  class BadRequestError < ApiError
-
-    # Code of the validation error
-    attr_reader :code
-
-    # @param message [String] custom message, usually includes API validation error code and it's meaning
-    # @param code [Integer] API validation code is passed separately to be evaluated in consumer's app
-    def initialize(message, code)
-      super message
-      @code = code
-    end
-  end
-
-  # 401 Unauthorized
-  class NotAuthorizedError < ApiError; end
-
-  # 403 Forbidden (not allowed)
-  class ForbiddenError < ApiError; end
-
-  # 404 Not Found
-  class NotFoundError < ApiError; end
-
-  # 406 NotAcceptable (used when requested representation is not supported by attachment)
-  class NotAcceptableError < ApiError; end
-
-  # 500 ServerError (internal error on API server)
-  class ServerError < ApiError; end
-
-  # have no idea what's going on - used in 'pokemon' rescue
-  class UnknownError < ApiError; end
-
-  # Constants for validation error codes in OrderRequest response
-  module OrderRequestErrorCodes
-    # 10001 Missing Inputs - if the order request did not contain any input media
-    MISSING_INPUTS = 10001
-
-    # 10002 Invalid Input - if one of the input media URIs is invalid, eg does not identify a valid media uploaded via a POST to /inputs
-    INVALID_INPUTS = 10002
-
-    # 10003 Transcription and Translation Specified - only one of the translation option and transcription option sections can be included
-    TC_AND_TR_OPTIONS_SPECIFIED = 10003
-
-    # 10001 Missing Inputs - if the order request did not contain any input media
-    TC_OR_TR_OPTIONS_NOT_SPECIFIED = 10004
-
-    # 10005 External Link and URI specified - only External Link or URI should be set for input media
-    EXTERNAL_LINK_AND_URI_SPECIFIED = 10005
-
-    # 10006 Input Location is not specified - neither of External Link and URI set for input media
-    EXTERNAL_LINK_OR_URI_NOT_SPECIFIED = 10006
-
-    # 20001 Invalid Media Length - If one of the input medias has a specified length that is not a positive integer
-    INVALID_MEDIA_LENGTH = 20001
-
-    # @deprecated Use {#OrderRequestErrorCodes.INVALID_MEDIA_LENGTH} instead
-    INVALID_AUDIO_LENGTH = INVALID_MEDIA_LENGTH
-
-    # 20002 Invalid Word Count - word counts for translation are missing or inaccurate
-    INVALID_WORD_COUNT = 20002
-
-    # 20003 Invalid Language Code - the language codes provided for translation are invalid
-    INVALID_LANGUAGE_CODE = 20003
-
-    # 20010 Reference Number Too Long Code - the reference number provided longer than 40 characters
-    REFERENCE_NUMBER_TOO_LONG = 20010
-
-    # 30001 Missing Payment Info - if the order request did not contain a payment information element
-    MISSING_PAYMENT_INFO = 30001
-
-    # 30002 Missing Payment Type - if the order request did not contain a payment kind element
-    MISSING_PAYMENT_TYPE = 30002
-
-    # 30010 Ineligible For Balance Payments - if the user on whose behalf the order request was made is not eligible for paying using account balance
-    INELIGIBLE_FOR_BALANCE_PAYMENT = 30010
-
-    # 30011 Account Balance Limit Exceeded - if the order request specified payment using account balance, but doing so would exceed the user's balance limit
-    ACCOUNT_BALANCE_LIMIT_EXCEEDED = 30011
-
-  end
-
-  module InputRequestErrorCodes
-    # 10001 Unsupported Content Type – if the content type of the media is not currently supported by our system.
-    # Supported media types for inputs are listed in https://www.rev.com/api/inputspost
-    UNSUPPORTED_CONTENT_TYPE = 10001
-
-    # 10002 Could not retrieve file – if we could not retrieve the file from the specified location.
-    COULD_NOT_RETRIEVE_MEDIA = 10002
-
-    # 10003 Invalid multipart request – If the multipart request did not contain exactly one file part, or was otherwise malformed.
-    INVALID_MULTIPART_REQUEST = 10003
-
-    # 10004 Unspecified filename - If the filename for the media was not specified explicitly and could not be determined automatically.
-    UNSPECIFIED_FILENAME = 10004
-  end
-
-end
+module Rev
+  class ApiError < StandardError; end
+
+  # 400 BadRequest. Response body contains API error code and optional details
+  class BadRequestError < ApiError
+
+    # Code of the validation error
+    attr_reader :code
+
+    # @param message [String] custom message, usually includes API validation error code and it's meaning
+    # @param code [Integer] API validation code is passed separately to be evaluated in consumer's app
+    def initialize(message, code)
+      super message
+      @code = code
+    end
+  end
+
+  # 401 Unauthorized
+  class NotAuthorizedError < ApiError; end
+
+  # 403 Forbidden (not allowed)
+  class ForbiddenError < ApiError; end
+
+  # 404 Not Found
+  class NotFoundError < ApiError; end
+
+  # 406 NotAcceptable (used when requested representation is not supported by attachment)
+  class NotAcceptableError < ApiError; end
+
+  # 500 ServerError (internal error on API server)
+  class ServerError < ApiError; end
+
+  # have no idea what's going on - used in 'pokemon' rescue
+  class UnknownError < ApiError; end
+
+  # Constants for validation error codes in OrderRequest response
+  module OrderRequestErrorCodes
+    # 10001 Missing Inputs - if the order request did not contain any input media
+    MISSING_INPUTS = 10001
+
+    # 10002 Invalid Input - if one of the input media URIs is invalid, eg does not identify a valid media uploaded via a POST to /inputs
+    INVALID_INPUTS = 10002
+
+    # 10003 Transcription and Translation Specified - only one of the translation option and transcription option sections can be included
+    TC_AND_TR_OPTIONS_SPECIFIED = 10003
+
+    # 10001 Missing Inputs - if the order request did not contain any input media
+    TC_OR_TR_OPTIONS_NOT_SPECIFIED = 10004
+
+    # 10005 External Link and URI specified - only External Link or URI should be set for input media
+    EXTERNAL_LINK_AND_URI_SPECIFIED = 10005
+
+    # 10006 Input Location is not specified - neither of External Link and URI set for input media
+    EXTERNAL_LINK_OR_URI_NOT_SPECIFIED = 10006
+
+    # 20001 Invalid Media Length - If one of the input medias has a specified length that is not a positive integer
+    INVALID_MEDIA_LENGTH = 20001
+
+    # @deprecated Use {#OrderRequestErrorCodes.INVALID_MEDIA_LENGTH} instead
+    INVALID_AUDIO_LENGTH = INVALID_MEDIA_LENGTH
+
+    # 20002 Invalid Word Count - word counts for translation are missing or inaccurate
+    INVALID_WORD_COUNT = 20002
+
+    # 20003 Invalid Language Code - the language codes provided for translation are invalid
+    INVALID_LANGUAGE_CODE = 20003
+
+    # 20010 Reference Number Too Long Code - the reference number provided longer than 40 characters
+    REFERENCE_NUMBER_TOO_LONG = 20010
+
+    # 30001 Missing Payment Info - if the order request did not contain a payment information element
+    MISSING_PAYMENT_INFO = 30001
+
+    # 30002 Missing Payment Type - if the order request did not contain a payment kind element
+    MISSING_PAYMENT_TYPE = 30002
+
+    # 30010 Ineligible For Balance Payments - if the user on whose behalf the order request was made is not eligible for paying using account balance
+    INELIGIBLE_FOR_BALANCE_PAYMENT = 30010
+
+    # 30011 Account Balance Limit Exceeded - if the order request specified payment using account balance, but doing so would exceed the user's balance limit
+    ACCOUNT_BALANCE_LIMIT_EXCEEDED = 30011
+
+  end
+
+  module InputRequestErrorCodes
+    # 10001 Unsupported Content Type – if the content type of the media is not currently supported by our system.
+    # Supported media types for inputs are listed in https://www.rev.com/api/inputspost
+    UNSUPPORTED_CONTENT_TYPE = 10001
+
+    # 10002 Could not retrieve file – if we could not retrieve the file from the specified location.
+    COULD_NOT_RETRIEVE_MEDIA = 10002
+
+    # 10003 Invalid multipart request – If the multipart request did not contain exactly one file part, or was otherwise malformed.
+    INVALID_MULTIPART_REQUEST = 10003
+
+    # 10004 Unspecified filename - If the filename for the media was not specified explicitly and could not be determined automatically.
+    UNSPECIFIED_FILENAME = 10004
+  end
+
+end

data/lib/rev-api/http_client.rb

@@ -1,97 +1,97 @@
-module Rev
-
-  # HTTP client handling authentication and HTTP requests at the low level for the Api class.
-  # Not indended to be used directly - clients should be using the Api class instead.
-  class HttpClient
-
-    include HTTParty
-
-    USER_AGENT = "RevOfficialRubySDK/#{VERSION}"
-
-    # Create a new HttpClient, connecting to given host, and using the given Client and User API Keys.
-    #
-    # @param client_api_key [String] the client API key to use for authenticating
-    # @param user_api_key [String] the user API key to use for authenticating
-    # @param host [String] the host to send requests to. Should be one of Rev::Api::PRODCUTION_HOST or Rev::Api::SANDBOX_HOST
-    def initialize(client_api_key, user_api_key, host)
-      endpoint_uri = "https://#{host}/api/v1"
-      self.class.base_uri(endpoint_uri)
-
-      auth_string = "Rev #{client_api_key}:#{user_api_key}"
-      @default_headers = {
-        'Authorization' => auth_string,
-        'User-Agent' => USER_AGENT # to track usage of SDK
-      }
-    end
-
-    # Performs HTTP GET of JSON data.
-    #
-    # @param operation [String] URL suffix describing specific operation, like '/orders'
-    # @param headers [Hash] hash of headers to use for the request
-    # @return [HTTParty::Response] response
-    def get(operation, headers = {})
-      headers = @default_headers.merge(headers)
-      self.class.get(operation, :headers => headers)
-    end
-
-    # Performs HTTP GET of binary data. Note, unlike post, this returns a
-    # Net::HTTP::Response, not HTTParty::Response.
-    #
-    # If this method is passed a block, will pass response to that block. in that case the response is not yet
-    # read into memory, so the block can read it progressively. otherwise, returns the response.
-    #
-    # @param operation [String] URL suffix describing specific operation, like '/orders'
-    # @param headers [Hash] hash of headers to use for the request
-    # @yieldparam resp [Net::HTTP::Response] the response, ready to be read
-    # @return [Net::HTTP::Response] response
-    def get_binary(operation, headers = {}, &block)
-      uri = URI.parse("#{self.class.base_uri}#{operation}")
-      headers = @default_headers.merge(headers)
-
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-
-      get = Net::HTTP::Get.new(uri.request_uri, headers)
-      if block_given?
-        http.request(get) do |resp|
-          yield resp
-        end
-      else
-        http.request(get)
-      end
-    end
-
-    # Performs HTTP POST of JSON data.
-    #
-    # @param operation[String] URL suffix describing specific operation
-    # @param data [Hash] hash of keys/values to post in request body
-    # @param headers [Hash] hash of headers to use for the request
-    # @return [HTTParty::Response] response
-    def post(operation, data = {}, headers = {})
-      headers = @default_headers.merge(headers)
-      self.class.post(operation, :headers => headers, :body => data)
-    end
-
-
-    # Performs HTTP POST of binary data. Note, unlike post, this returns a
-    # Net::HTTP::Response, not HTTParty::Response.
-    #
-    # @param operation[String] URL suffix describing specific operation
-    # @param file [File] file-like object containing the data to post
-    # @param headers [Hash] hash of headers to use for the request
-    # @return [Net::HTTP::Response] response
-    def post_binary(operation, file, headers = {})
-      uri = URI.parse("#{self.class.base_uri}#{operation}")
-      headers = @default_headers.merge(headers)
-
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-
-      post = Net::HTTP::Post.new(uri.request_uri, headers)
-      post["Content-Length"] = file.stat.size.to_s
-      post.body_stream = file
-
-      response = http.request(post)
-    end
-  end
-end
+module Rev
+
+  # HTTP client handling authentication and HTTP requests at the low level for the Api class.
+  # Not indended to be used directly - clients should be using the Api class instead.
+  class HttpClient
+
+    include HTTParty
+
+    USER_AGENT = "RevOfficialRubySDK/#{VERSION}"
+
+    # Create a new HttpClient, connecting to given host, and using the given Client and User API Keys.
+    #
+    # @param client_api_key [String] the client API key to use for authenticating
+    # @param user_api_key [String] the user API key to use for authenticating
+    # @param host [String] the host to send requests to. Should be one of Rev::Api::PRODCUTION_HOST or Rev::Api::SANDBOX_HOST
+    def initialize(client_api_key, user_api_key, host)
+      endpoint_uri = "https://#{host}/api/v1"
+      self.class.base_uri(endpoint_uri)
+
+      auth_string = "Rev #{client_api_key}:#{user_api_key}"
+      @default_headers = {
+        'Authorization' => auth_string,
+        'User-Agent' => USER_AGENT # to track usage of SDK
+      }
+    end
+
+    # Performs HTTP GET of JSON data.
+    #
+    # @param operation [String] URL suffix describing specific operation, like '/orders'
+    # @param headers [Hash] hash of headers to use for the request
+    # @return [HTTParty::Response] response
+    def get(operation, headers = {})
+      headers = @default_headers.merge(headers)
+      self.class.get(operation, :headers => headers)
+    end
+
+    # Performs HTTP GET of binary data. Note, unlike post, this returns a
+    # Net::HTTP::Response, not HTTParty::Response.
+    #
+    # If this method is passed a block, will pass response to that block. in that case the response is not yet
+    # read into memory, so the block can read it progressively. otherwise, returns the response.
+    #
+    # @param operation [String] URL suffix describing specific operation, like '/orders'
+    # @param headers [Hash] hash of headers to use for the request
+    # @yieldparam resp [Net::HTTP::Response] the response, ready to be read
+    # @return [Net::HTTP::Response] response
+    def get_binary(operation, headers = {}, &block)
+      uri = URI.parse("#{self.class.base_uri}#{operation}")
+      headers = @default_headers.merge(headers)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      get = Net::HTTP::Get.new(uri.request_uri, headers)
+      if block_given?
+        http.request(get) do |resp|
+          yield resp
+        end
+      else
+        http.request(get)
+      end
+    end
+
+    # Performs HTTP POST of JSON data.
+    #
+    # @param operation[String] URL suffix describing specific operation
+    # @param data [Hash] hash of keys/values to post in request body
+    # @param headers [Hash] hash of headers to use for the request
+    # @return [HTTParty::Response] response
+    def post(operation, data = {}, headers = {})
+      headers = @default_headers.merge(headers)
+      self.class.post(operation, :headers => headers, :body => data)
+    end
+
+
+    # Performs HTTP POST of binary data. Note, unlike post, this returns a
+    # Net::HTTP::Response, not HTTParty::Response.
+    #
+    # @param operation[String] URL suffix describing specific operation
+    # @param file [File] file-like object containing the data to post
+    # @param headers [Hash] hash of headers to use for the request
+    # @return [Net::HTTP::Response] response
+    def post_binary(operation, file, headers = {})
+      uri = URI.parse("#{self.class.base_uri}#{operation}")
+      headers = @default_headers.merge(headers)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      post = Net::HTTP::Post.new(uri.request_uri, headers)
+      post["Content-Length"] = file.stat.size.to_s
+      post.body_stream = file
+
+      response = http.request(post)
+    end
+  end
+end