bitmovin-api 0.0.1.pre

data/bitmovin-api.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path('../lib/bitmovin/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'bitmovin-api'
+  s.version       = Bitmovin::VERSION
+  s.date          = '2017-02-09'
+  s.summary       = "Bitmovin api client"
+  s.description   = "Simple ruby wrapper for bitmovin encoding service api. Written in pure ruby with no runtime dependencies."
+  s.authors       = ["DevilsNightsix"]
+  s.email         = 'eeendi94@gmail.com'
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.require_paths = ["lib"]
+  s.homepage      = 'http://rubygems.org/gems/bitmovin-api'
+  s.license       = 'MIT'
+  s.add_development_dependency "yard"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "byebug"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-minitest"
+  s.add_development_dependency "apib-mock_server"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "minitest-color"
+end

data/lib/bitmovin.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'bitmovin/helpers'
+require 'bitmovin/input'
+require 'bitmovin/output'
+require 'bitmovin/encoding_profile'
+require 'bitmovin/transfer_job'
+require 'bitmovin/job'
+
+module Bitmovin
+  
+  API_URL = 'https://portal.bitcodin.com/api'
+  API_URI = URI(API_URL)
+  
+  @@api_key = nil
+  @@http = Net::HTTP.new API_URI.host, API_URI.port
+  @@http.use_ssl = API_URI.scheme == "https"
+
+  class << self
+    def api_key=(key)
+      @@api_key = key
+    end
+
+    def http
+      @@http
+    end
+
+    def api_key
+      @@api_key
+    end
+  end
+
+  class ApiParameterEmptyError < StandardError
+
+    def initialize(msg = "Is required", parameter)
+      @parameter = parameter
+      @msg = msg
+    end
+  end
+end

data/lib/bitmovin/encoding_profile.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require File.expand_path('../helpers', __FILE__)
+
+module Bitmovin
+  # Represents a bitmovin encoding profile
+  # @see https://bitmovin.com/encoding-documentation/encoder-api-reference-documentation/#/reference/encoding-profiles Bitmovin Encoding Profiles docs
+  class EncodingProfile
+
+    include Bitmovin::Helpers
+
+    ATTRIBUTES = %i{
+      encoding_profile_id
+      video_stream_configs
+      audio_stream_configs
+      watermark_config
+      created_at
+      type
+      name
+    }
+
+    ATTRIBUTES.each do |_attr|
+      define_method _attr do
+        @details[_attr]
+      end
+
+      define_method :"#{_attr}=" do |value|
+        @details[_attr] = value
+      end
+    end
+
+    ##
+    # @param params Encoding profile video & audio configurations
+    # * :name Name of new Encoding profile
+    # * :rotation Rotation of the video in degrees. A positive value will rotate the video clockwise and a negative one counter clockwise.
+    # * :segment_length Only available using standard speed. Defines the length of a segment. Must be a value between 1 and 9 seconds.
+    # * :video_stream_configs An array of video profile configs
+    #   * :default_stream_id ID of the video stream which should be encoded
+    #   * :representation_id ID of the video stream config
+    #   * :bitrate Bitrate of the video stream. Value must be in the range from 32000 to 20000000
+    #   * :profile Profile which should be used to encode video stream. Possible values are: baseline, main, high
+    #   * :preset Preset which should be used to encode video stream. Possible values are: standard, professional, premium
+    #   * :height Video-Width in px, must be in the range from 128 to 7680
+    #   * :width Video-Height in px, must be in the range from 96 to 4320
+    #   * :rate Only available using standard speed. The sample rate the encoded video should have in FPS. Values must be in the range from 1 to 120
+    #   * :codec Only available using premium speed. Sets the video codec used for encoding. Possible values are: h264, hevc. Default value is h264.
+    #   * :b_frames Sets the amount of B-Frames. Valid value range: 0 - 16
+    #   * :ref_frames Sets the amount of Reference-Frames. Valid value range: 0 - 16
+    #   * :qp_min Sets the minimum of quantization-factor. Valid value range: 0 - 69
+    #   * :qp_max Sets the maximum of quantization-factor. Valid value range: 0 - 69
+    #   * :mv_prediction_mode Sets the Motion Vector Prediction Mode. Valid values: none, spatial, temporal, auto
+    #   * :mv_search_range_max Sets the maximum Motion-Vector-Search-Range. Valid value range: 16 - 24
+    #   * :no_cabac Disable CABAC.
+    # * :audio_stream_configs An array of audio profile configs
+    #   * :default_stream_id ID of the audio stream which should be encoded
+    #   * :representation_id ID of the audio stream config
+    #   * :bitrate Bitrate of the audio stream. Values must be in the range from 8000 to 256000
+    #   * :rate The sample rate the encoded audio should have in Hz. Possible values are: 0, 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000
+    # * :watermark_config A watermark config
+    #   * :top Distance between the top of the watermark image and the top of the input video
+    #   * :left Distance between the left side of the watermark image and the left side of the input video
+    #   * :bottom Distance between the bottom of the watermark image and the bottom of the input video
+    #   * :right Distance between the right of the watermark image and the right of the input video
+    # * :cropping_config
+    #   * :top Amount of pixel which will be cropped of the input video from the top.
+    #   * :left Amount of pixel which will be cropped of the input video from the left side.
+    #   * :bottom Amount of pixel which will be cropped of the input video from the bottom.
+    #   * :right Amount of pixel which will be cropped of the input video from the right side.
+    #
+    def initialize(params={})
+      @details = params
+    end
+
+    ##
+    # Create encoding profile with params given within initialization
+    #
+    # return [Bitmovin::EncodingProfile] create bitmovin encoding profile
+    def create
+      make_create_request
+      self
+    end
+
+    ##
+    # @param params Encoding profile video & audio configurations
+    # * :name Name of new Encoding profile
+    # * :rotation Rotation of the video in degrees. A positive value will rotate the video clockwise and a negative one counter clockwise.
+    # * :segment_length Only available using standard speed. Defines the length of a segment. Must be a value between 1 and 9 seconds.
+    # * :video_stream_configs An array of video profile configs
+    #   * :default_stream_id ID of the video stream which should be encoded
+    #   * :representation_id ID of the video stream config
+    #   * :bitrate Bitrate of the video stream. Value must be in the range from 32000 to 20000000
+    #   * :profile Profile which should be used to encode video stream. Possible values are: baseline, main, high
+    #   * :preset Preset which should be used to encode video stream. Possible values are: standard, professional, premium
+    #   * :height Video-Width in px, must be in the range from 128 to 7680
+    #   * :width Video-Height in px, must be in the range from 96 to 4320
+    #   * :rate Only available using standard speed. The sample rate the encoded video should have in FPS. Values must be in the range from 1 to 120
+    #   * :codec Only available using premium speed. Sets the video codec used for encoding. Possible values are: h264, hevc. Default value is h264.
+    #   * :b_frames Sets the amount of B-Frames. Valid value range: 0 - 16
+    #   * :ref_frames Sets the amount of Reference-Frames. Valid value range: 0 - 16
+    #   * :qp_min Sets the minimum of quantization-factor. Valid value range: 0 - 69
+    #   * :qp_max Sets the maximum of quantization-factor. Valid value range: 0 - 69
+    #   * :mv_prediction_mode Sets the Motion Vector Prediction Mode. Valid values: none, spatial, temporal, auto
+    #   * :mv_search_range_max Sets the maximum Motion-Vector-Search-Range. Valid value range: 16 - 24
+    #   * :no_cabac Disable CABAC.
+    # * :audio_stream_configs An array of audio profile configs
+    #   * :default_stream_id ID of the audio stream which should be encoded
+    #   * :representation_id ID of the audio stream config
+    #   * :bitrate Bitrate of the audio stream. Values must be in the range from 8000 to 256000
+    #   * :rate The sample rate the encoded audio should have in Hz. Possible values are: 0, 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000
+    # * :watermark_config A watermark config
+    #   * :top Distance between the top of the watermark image and the top of the input video
+    #   * :left Distance between the left side of the watermark image and the left side of the input video
+    #   * :bottom Distance between the bottom of the watermark image and the bottom of the input video
+    #   * :right Distance between the right of the watermark image and the right of the input video
+    # * :cropping_config
+    #   * :top Amount of pixel which will be cropped of the input video from the top.
+    #   * :left Amount of pixel which will be cropped of the input video from the left side.
+    #   * :bottom Amount of pixel which will be cropped of the input video from the bottom.
+    #   * :right Amount of pixel which will be cropped of the input video from the right side.
+    #
+    def self.create(params={})
+      new(params).create
+    end
+
+    ##
+    # Get encoding profile details as hash
+    # @param reload [Boolean] Reload details from server
+    # @return [Hash] encoding profile details
+    #
+    def details(reload = false)
+      return @details unless reload
+
+      reload_details
+    end
+
+    class << self
+      include Bitmovin::Helpers
+
+      ##
+      # Get list of available encoding profiles by pages per 10
+      # @param page [Integer] number of page
+      # @return [Array<Bitmovin::EncodingProfile>] array of encoding profiles
+      #
+      def list(page = 1)
+        get = Net::HTTP::Get.new "/api/encoding-profiles/#{page}", initheaders = headers
+
+        response = Bitmovin.http.request get
+
+        json = prepare_response_json(response.body)
+
+        json[:profiles].map { |p| Bitmovin::EncodingProfile.new(p) }
+      end
+    end
+
+    private
+
+    def reload_details
+      get = Net::HTTP::Get.new "/api/encoding-profile/#{encoding_profile_id}"
+
+      response = Bitmovin.http.request get
+
+      @details = prepare_response_json(response.body)
+      @details
+    end
+
+    def make_create_request
+      payload = prepare_request_json(@details)
+
+      post = Net::HTTP::Post.new "/api/encoding-profile/create", initheaders = headers
+      post.body = payload
+
+      response = Bitmovin.http.request post
+
+      @details = prepare_response_json(response.body)
+      self
+    end
+
+  end
+end

data/lib/bitmovin/helpers.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Bitmovin
+  module Helpers
+
+    S3_BUCKET_SUBDOMAIN_REGEX = /^https?:\/\/(.*)\.s3/.freeze
+    S3_BUCKET_IN_URL_REGEX = /^https?:\/\/s3\.amazonaws\.com\/([\w\-\_]+)\//.freeze
+
+    S3_OBJECT_KEY_SUBDOMAIN_REGEX = /^https?:\/\/(?:.*)\.s3\.amazonaws\.com\/(.*)/.freeze
+    S3_OBJECT_KEY_IN_URL_REGEX = /^https?:\/\/s3\.amazonaws\.com\/[\w\-\_]+\/(.*)/.freeze
+
+    ##
+    # Converting passed hash to be acceptable by bitmivin api
+    #
+    # @param hash [Hash] the hash to be converted
+    #
+    # @return [String] valid json string
+    #
+    def prepare_request_json(hash)
+      json = deep_camelize_keys(hash)
+      JSON.generate(json)
+    end
+
+    ##
+    # Converting bitmovin api response json to ruby hash
+    #
+    # @param json [String] json string with camelcased keys
+    #
+    # @return [Hash] parsed api response with snakecased keys
+    #
+    def prepare_response_json(json)
+      json = JSON.parse json
+
+      if json.is_a?(Hash)
+        deep_underscore_keys json
+      elsif json.is_a?(Array)
+        json.map { |ji| deep_underscore_keys(ji) }
+      end
+    end
+
+    ##
+    # Converts hash keys to string in camelCase
+    # @param subject [Hash] Hash to be converted
+    # @param first_letter_in_uppercase [Boolean] Is first letter should be uppercased
+    #
+    # @return [Hash] converted hash with stringified keys in camelCase
+    def deep_camelize_keys(subject, first_letter_in_uppercase = false)
+      init_value = Hash.new
+      subject.inject init_value do |acc, props|
+        acc[camelize(props.first.to_s, first_letter_in_uppercase).to_sym] = case props.last
+          when Hash then deep_camelize_keys(props.last, first_letter_in_uppercase)
+          when Array then props.last.map { |i| i.is_a?(Hash) ? deep_camelize_keys(i, first_letter_in_uppercase) : i }
+          else props.last
+          end
+        acc
+      end
+    end
+
+    ##
+    # Converts hash keys to symbols in snake_case
+    # @param subject [Hash] Hash to be converted
+    #
+    # @return [Hash] converted hash with symbolized keys in snake_case
+    def deep_underscore_keys(subject)
+      init_value = subject.class.new if subject.is_a?(Hash) || subject.is_a?(Array)
+      subject.inject init_value do |acc, props|
+        acc[underscore(props.first.to_s).to_sym] = case props.last
+          when Hash then deep_underscore_keys(props.last)
+          when Array then props.last.map { |i| i.is_a?(Hash) ? deep_underscore_keys(i) : i }
+          else props.last
+          end
+        acc
+      end
+    end
+
+
+    ##
+    # Extracts AWS S3 bucket name from url
+    #
+    # @param url [String] url to AWS S3 file
+    #
+    # @return [String] name of bucket
+    #
+    def extract_bucket(url)
+      unescaped = URI.unescape(url)
+
+      bucket = unescaped.match(S3_BUCKET_SUBDOMAIN_REGEX)[1] rescue nil
+      bucket ||= unescaped.match(S3_BUCKET_IN_URL_REGEX)[1] rescue nil
+
+      bucket
+    end
+
+    ##
+    # Extracts AWS S3 file name from url
+    #
+    # @param url [String] url to AWS S3 file
+    #
+    # @return [String] name of file with containing folders
+    #
+    def extract_object_key(url)
+      unescaped = URI.unescape(url)
+
+      file = unescaped.match(S3_OBJECT_KEY_SUBDOMAIN_REGEX)[1] rescue nil
+      file ||= unescaped.match(S3_OBJECT_KEY_IN_URL_REGEX)[1] rescue nil
+
+      file
+    end
+
+    protected
+
+    def headers
+      @headers ||= {
+        'Content-Type' => "application/json",
+        'bitcodin-api-version' => 'v1',
+        'bitcodin-api-key' => Bitmovin.api_key
+      }
+    end
+
+
+    def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+      if first_letter_in_uppercase
+        lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+      else
+        lower_case_and_underscored_word[0] + camelize(lower_case_and_underscored_word)[1..-1]
+      end
+    end
+
+    def underscore(str)
+      str.gsub(/[A-Z\s]/) { "_#{$&.downcase}" }
+    end
+
+  end
+end
+

data/lib/bitmovin/input.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require File.expand_path('../helpers', __FILE__)
+
+module Bitmovin
+  # Represents a bitmovin input
+  # @see https://bitmovin.com/encoding-documentation/encoder-api-reference-documentation/#/reference/inputs/ Bitmovin Input docs
+  class Input
+
+    include Bitmovin::Helpers
+
+    ATTRIBUTES = %i{
+      input_id
+      async
+      type
+      url
+      username
+      password
+      region
+      bucket
+      object_key
+      access_key
+      secret_key
+      account_name
+      account_key
+      container
+      min_bandwidth
+      max_bandwidth
+    }
+
+    ATTRIBUTES.each do |_attr|
+      define_method _attr do
+        @params[_attr]
+      end
+
+      define_method :"#{_attr}=" do |value|
+        @params[_attr] = value
+      end
+    end
+
+
+    attr_reader :params, :url
+
+    #
+    # @overload initialize(url, params)
+    #   @param url [String] url of input for URL, S3 or Aspera inputs
+    #   @param params [String] input params
+    #   @option params {Boolean] :async Create input async
+    #   @option params [String] :type Type of input
+    #   @option params [String] :username Basic auth username
+    #   @option params [String] :password Basic auth password
+    #   @option params [String] :region ('us-east-1') S3 bucket region
+    #   @option params [String] :bucket S3 bucket name for s3 input, also can be infered from url
+    #   @option params [String] :object_key S3 object name with containing folder, can be infered from url
+    #   @option params [String] :access_key S3 or GCS access key, required for S3 or GCS inputs
+    #   @option params [String] :secret_key S3 or GCS secret, required for S3 or GCS inputs
+    #   @option params [String] :account_name MS Azure account name, required for Azure inputs
+    #   @option params [String] :account_key MS Azure account key, required for Azure inputs
+    #   @option params [String] :container MS Azure storage container name
+    #   @option params [String] :min_bandwidth, Minimal download bandwidth
+    #   @option params [String] :max_bandwidth, Maximal download bandwidth
+    #
+    # @overload initialize(params)
+    #   @param params [String] input params
+    #   @option params {Boolean] :async Create input async
+    #   @option params [String] :type Type of input
+    #   @option params [String] :url Aspera/Azure file url
+    #   @option params [String] :username Basic auth username
+    #   @option params [String] :password Basic auth password
+    #   @option params [String] :region ('us-east-1') S3 bucket region
+    #   @option params [String] :bucket S3 bucket name for s3 input, also can be infered from url
+    #   @option params [String] :object_key S3 object name with containing folder, can be infered from url
+    #   @option params [String] :access_key S3 or GCS access key, required for S3 or GCS inputs
+    #   @option params [String] :secret_key S3 or GCS secret, required for S3 or GCS inputs
+    #   @option params [String] :account_name MS Azure account name, required for Azure inputs
+    #   @option params [String] :account_key MS Azure account key, required for Azure inputs
+    #   @option params [String] :container MS Azure storage container name
+    #   @option params [String] :min_bandwidth, Minimal download bandwidth
+    #   @option params [String] :max_bandwidth, Maximal download bandwidth
+    #
+    #
+    # @return [Hash] Input details as a hash
+    #
+    def initialize(*args)
+      @params = args.pop
+
+      @url = args.pop if args.length == 1
+
+      if @url
+        @params[:bucket] = extract_bucket(url) if !@params[:bucket] && @params[:type] == "s3"
+        @params[:object_key] = extract_object_key(url) if !@params[:object_key]  && @params[:type] == "s3"
+        @params[:url]
+      end
+    end
+
+    ##
+    # Creates a new bitmovin input
+    #
+    # @param (#initialize)
+    #
+    # @return [Bitmovin::Input] Bitmovin Input details
+    #
+    def self.create(*args)
+      new(*args).create
+    end
+
+    ##
+    # Creates a new bitmovin input with params given within initialization
+    # @return [Bitmovin::Input] Bitmovin Input details
+    #
+    def create
+      make_create_request
+    end
+
+    ##
+    # Get bitmovin input details
+    # @param reload [Boolean] force data reload from server
+    def details(reload = false)
+      return @params if !reload && @params
+
+      reload_details
+    end
+
+    private
+
+    ##
+    #@private
+    def make_create_request
+      if %w{s3 gcs}.include? params[:type]
+        raise Bitmovin::ApiParameterEmptyError.new(parameter = :access_key) unless params[:access_key]
+        raise Bitmovin::ApiParameterEmptyError.new(parameter = :secret_key) unless params[:secret_key]
+      end
+
+      payload = prepare_request_json(params)
+      path = params[:async] ? "/api/input/createasync" : "/api/input/create"
+      post = Net::HTTP::Post.new path, initheaders = headers
+      post.body = payload
+
+      response = Bitmovin.http.request post
+
+      @params = prepare_response_json(response.body)
+      self
+    rescue Net::HTTPRequestTimeOut => e
+      nil
+    end
+
+    ##
+    #@private
+    def reload_details
+      get = Net::HTTP::Get.new "/api/input/#{@params[:input_id]}", initheaders = headers
+
+      response = Bitmovin.http.request get
+
+      @params = prepare_response_json(response.body)
+    end
+  end
+end