bitmovin-api 0.0.1.pre

data/lib/bitmovin/job.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require File.expand_path('../helpers', __FILE__)
+
+module Bitmovin
+  # Represents a bitmovin Job
+  # @see https://bitmovin.com/encoding-documentation/encoder-api-reference-documentation/#/reference/jobs Bitmovin Job docs
+  class Job
+    include Bitmovin::Helpers
+
+    ATTRIBUTES = %i{
+      job_id
+      input_id
+      output_id
+      speed
+      encoding_profile_id
+      audio_meta_data
+      manifest_types
+      deinterlace
+      extract_closed_captinos
+      merge_audio_channel_configs
+      duration
+      start_time
+      created_at
+    }
+
+    ATTRIBUTES.each do |_attr|
+      define_method _attr do
+        @details[_attr]
+      end
+
+      define_method :"#{_attr}=" do |value|
+        @details[_attr] = value
+      end
+    end
+
+    #
+    # @param params [Hash] Job details
+    # @option params input_id [Integer] Job input id
+    # @option params output_id [Integer] Job output id
+    # @option params encoding_profile_id [Integer] Encoding profile id
+    # @option params audio_meta_data [Hash] Meta data of the audio streams (Only available when using standard as speed setting)
+    #   * :default_stream_id (Integer) - Default stream id of the audio stream
+    #   * :language (String) - Language abbreviation [ISO 639-1]
+    #   * :label (String) - Label of the language field
+    # @option params manifest_types [Array<String>] Available values: mpd | m3u8
+    # @option params extract_closed_captinos [Boolean] Extract closed captions from the input file
+    # @option params deinterlace [Boolean] Create de-interlaced output
+    # @option params merge_audio_channel_configs [Hash] Merge multiple mono audio input streams to stereo or 5.1 audio streams (Only available when using standard as speed setting)
+    #  * :audio_channels [Array] - Array of mono input streams
+    #
+    def initialize(params={})
+      @details = params
+    end
+
+    #
+    # @param params [Hash] Job details
+    # @option params input_id [Integer] Job input id
+    # @option params output_id [Integer] Job output id
+    # @option params encoding_profile_id [Integer] Encoding profile id
+    # @option params audio_meta_data [Hash] Meta data of the audio streams (Only available when using standard as speed setting)
+    #   * :default_stream_id (Integer) - Default stream id of the audio stream
+    #   * :language (String) - Language abbreviation [ISO 639-1]
+    #   * :label (String) - Label of the language field
+    # @option params manifest_types [Array<String>] Available values: mpd | m3u8
+    # @option params extract_closed_captinos [Boolean] Extract closed captions from the input file
+    # @option params deinterlace [Boolean] Create de-interlaced output
+    # @option params merge_audio_channel_configs [Hash] Merge multiple mono audio input streams to stereo or 5.1 audio streams (Only available when using standard as speed setting)
+    #  * :audio_channels [Array] - Array of mono input streams
+    #
+    def self.create(params={})
+      new(params).create
+    end
+
+    ##
+    # Creates a new bitmovin encoding job with params given within initialization
+    # @return [Bitmovin::Job] Bitmovin Job details
+    def create
+      make_create_request
+    end
+
+    ##
+    # Get bitmovin encoding job details
+    # @param reload Force reload from server
+    # @return [Hash] Bitmovin Job details
+    def details(reload = false)
+      return @details unless reload
+
+      reload_details
+    end
+
+    # Get bitmovin encoding job status
+    # @param reload Force reload from server
+    # @return [Hash] Bitmovin Job details
+    def status(reload = false)
+      return @status if !reload && @status
+
+      reload_status
+    end
+
+    # Get bitmovin encoding job status
+    # @param reload Force reload from server
+    # @return [Hash] Bitmovin Job details
+    def manifest(reload = false)
+      return @manifest if !reload && @manifest
+
+      reload_manifest
+    end
+
+    class << self
+      include Bitmovin::Helpers
+
+      ##
+      # Get list of available jobs (10 Jobs per page)
+      # @param status [String, Symbol] Available values: all | finished | enqueued | inprogress | error
+      # @param page [Integer] number of page
+      # @param reload [Integer] Force reload from server
+      # @return [Array<Bitmovin::Job>] array of encoding profiles
+      #
+      def list(status = :all, page = 1, reload = false)
+        var_name = :"@#{status}_list#{ page }"
+
+        val = instance_variable_get var_name
+
+        return val if val && !relaod
+
+        get = Net::HTTP::Get.new "/api/jobs/#{ page }/#{ status }", initheaders = headers
+
+        response = Bitmovin.http.request get
+
+        json = prepare_response_json(response.body)
+        
+        value_to_set = json[:jobs].map { |p| Bitmovin::Job.new(p) }
+
+        instance_variable_set var_name, value_to_set
+      end
+    end
+
+    private
+
+    def reload_manifest
+      get = Net::HTTP::Get.new "/api/job/#{ @details[:job_id] }/manifest-info", initheaders = headers
+
+      response = Bitmovin.http.request get
+
+      @manifest = prepare_response_json response.body
+      @manifest
+    end
+
+    def reload_status
+      get = Net::HTTP::Get.new "/api/job/#{ @details[:job_id] }/status", initheaders = headers
+
+      response = Bitmovin.http.request get
+
+      @status = prepare_response_json response.body
+      @status
+    end
+
+    def reload_details
+      get = Net::HTTP::Get.new "/api/job/#{ @details[:job_id] }", initheaders = headers
+
+      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/job/create", initheaders = headers
+      post.body = payload
+
+      response = Bitmovin.http.request post
+
+      @details = prepare_response_json response.body
+      self
+    end
+  end
+end

data/lib/bitmovin/output.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require File.expand_path('../helpers', __FILE__)
+
+module Bitmovin
+  # Represents a bitmovin Output
+  # @see https://bitmovin.com/encoding-documentation/encoder-api-reference-documentation/#/reference/outputs Bitmovin Output docs
+  class Output
+    include Bitmovin::Helpers
+
+    ##
+    #@private
+    ATTRIBUTES = %i{
+      output_id
+      type
+      name
+      bucket
+      region
+      access_key
+      secret_key
+      account_name
+      account_key
+      container
+      prefix
+      make_public
+      create_sub_directory
+    }
+
+    ATTRIBUTES.each do |_attr|
+      define_method _attr do
+        @details[_attr]
+      end
+
+      define_method :"#{_attr}=" do |value|
+        @details[_attr] = value
+      end
+    end
+
+    ##
+    # @param params [Hash] Output details
+    # @option params [String] :type Type of Output
+    # @option params [String] :name Name of output profile
+    # @option params [String] :bucket S3 Bucket name for s3 output
+    # @option params [String] :region ('us-east-1') S3 region of bucket, required for S3 outputs
+    # @option params [String] :access_key S3/GCS Access Key, required for S3 outputs
+    # @option params [String] :secret_key S3/GCS Secret key, required for S3 outputs
+    # @option params [String] :account_name MS Azure account name, required for Azure outputs
+    # @option params [String] :account_key MS Azure account key, required for Azure outputs
+    # @option params [String] :container Name of Azure storage container
+    # @option params [String] :prefix Virtual sub-directory for file
+    # @option params [Boolean] :make_public If true, all transfered files can be accessed by their respective URL from anyone
+    # @option params [Boolean] :create_sub_directory (true) if true, create a sub directory for your job (<job_id>_<hash>)
+    #
+    def initialize(params={})
+      @details = params
+    end
+
+    ##
+    # Creates a new bitmovin output
+    #
+    # @param (#initialize)
+    #
+    # @return [Bitmovin::Output] Bitmovin Output details
+    #
+    def self.create(params={})
+      new(params).create
+    end
+
+    ##
+    # Creates a new bitmovin output with params given within initialization
+    # @return [Bitmovin::Input] Bitmovin Output details
+    #
+    def create
+      make_create_request
+    end
+
+    ##
+    # Get bitmovin input details
+    # @param reload [Boolean] force data reload from server
+    # @return [Hash] output data as a ruby hash
+    def details(reload = false)
+      return @details if !reload && @details
+
+      reload_details
+    end
+
+    private
+
+    ##
+    # @private
+    def make_create_request
+      if %w{s3 gcs}.include? @details[:type]
+        raise Bitmovin::ApiParameterEmptyError.new(parameter = :access_key) unless @details[:access_key]
+        raise Bitmovin::ApiParameterEmptyError.new(parameter = :secret_key) unless @details[:secret_key]
+      end
+
+      payload = prepare_request_json @details
+      post = Net::HTTP::Post.new "/api/output/create", initheaders = headers
+      post.body = payload
+
+      response = Bitmovin.http.request post
+
+      @details = prepare_response_json response.body
+      self
+    rescue Net::HTTPRequestTimeOut => e
+      nil
+    end
+
+    ##
+    # private
+    def reload_details
+      get = Net::HTTP::Get.new "/api/output/#{@params[:output_id]}", initheaders = headers
+      response = Bitmovin.http.request get
+
+      @details = prepare_response_json response.body
+    end
+  end
+end

data/lib/bitmovin/transfer_job.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require File.expand_path('../helpers', __FILE__)
+
+module Bitmovin
+  # Represents a bitmovin transfer Job
+  # @see https://bitmovin.com/encoding-documentation/encoder-api-reference-documentation/#/reference/jobs Bitmovin Job docs
+  class TransferJob
+    include Bitmovin::Helpers
+
+    ATTRIBUTES = %i{
+      id
+      job_id
+      output_id
+      status
+      progress
+      created_at
+      output_name
+    }
+
+    ATTRIBUTES.each do |_attr|
+      define_method _attr do
+        @details[_attr]
+      end
+
+      define_method :"#{_attr}=" do |value|
+        @details[_attr] = value
+      end
+    end
+
+    #
+    # @option params job_id [Integer] Job-ID
+    # @option params output_id [Integer] Output-ID
+    #
+    def initialize(params={})
+      @details = params
+    end
+
+    #
+    # @option params job_id [Integer] Job-ID
+    # @option params output_id [Integer] Output-ID
+    #
+    # @return [Bitmovin::TransferJob] Bitmovin Transfer Job details
+    #
+    def self.create(params={})
+      new(params).create
+    end
+
+    ##
+    # Creates a new bitmovin transfer job with params given within initialization
+    # @return [Bitmovin::TransferJob] Bitmovin Transfer Job details
+    def create
+      make_create_request
+    end
+
+    ##
+    # Get bitmovin encoding job details
+    # @param reload Force reload from server
+    # @return [Hash] Bitmovin Job details
+    def details(reload = false)
+      return @details
+    end
+
+    class << self
+      include Bitmovin::Helpers
+
+      ##
+      # Get list of available transfers related to job
+      # @return [Array<Bitmovin::TransferJob>] array of transfer jobs
+      #
+      def list(reload = false)
+        return @list if @list && !relaod
+
+        get = Net::HTTP::Get.new "/api/jobs/#{ @details[:job_id] }/transfers", initheaders = headers
+
+        response = Bitmovin.http.request get
+
+        json = prepare_response_json(response.body)
+
+        @list = json[:jobs].map { |p| Bitmovin::TransferJob.new(p) }
+
+        @list
+      end
+    end
+
+    private
+
+    def make_create_request
+      payload = prepare_request_json @details
+
+      post = Net::HTTP::Post.new "/api/job/transfer", initheaders = headers
+      post.body = payload
+
+      response = Bitmovin.http.request post
+      puts response
+
+      @details = prepare_response_json response.body
+      self
+    end
+  end
+end

data/lib/bitmovin/version.rb

@@ -0,0 +1,3 @@
+module Bitmovin
+  VERSION = "0.0.1.pre"
+end

data/test_api.rb

@@ -0,0 +1,10 @@
+require 'rack'
+require "apib/mock_server"
+
+base_url = "http://private-anon-6f2a0baf67-bitcodinrestapi.apiary-proxy.com/api"
+api_b = File.expand_path('../bitcodinrestapi.apib', __FILE__)
+blueprint = File.read(api_b)
+
+app = Apib::MockServer.new(base_url, blueprint)
+
+Rack::Handler.default.run app

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: bitmovin-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- DevilsNightsix
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: apib-mock_server
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-color
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple ruby wrapper for bitmovin encoding service api. Written in pure
+  ruby with no runtime dependencies.
+email: eeendi94@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- bitcodinrestapi.apib
+- bitmovin-api.gemspec
+- lib/bitmovin.rb
+- lib/bitmovin/client.rb
+- lib/bitmovin/encoding_profile.rb
+- lib/bitmovin/helpers.rb
+- lib/bitmovin/input.rb
+- lib/bitmovin/job.rb
+- lib/bitmovin/output.rb
+- lib/bitmovin/transfer_job.rb
+- lib/bitmovin/version.rb
+- test_api.rb
+homepage: http://rubygems.org/gems/bitmovin-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.0
+signing_key: 
+specification_version: 4
+summary: Bitmovin api client
+test_files: []