brightcove_service 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e13be3e0d160644b576de30918e3926d079da1ae
+  data.tar.gz: a515b16036d5699c539c329df1d0faeed4c3658d
+SHA512:
+  metadata.gz: e23870eb9ff727bc828a80aea87bc47689db5ad8cf1ef79b7e273e8735da0312ca54e99afa8bfd8a8a1a6f9edd3c1ac0d5395dea06890c071faba3074bf27e22
+  data.tar.gz: 358b9588c1ea4ee20f6b2243894d77d3ae80fea4b2976fde95986e681e806044c6c0c3cc36fd07f97704d4438193cd8c2854be49342153bcd3307c873b70cdcc

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at anil@joshsoftware.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in brightcove_service.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Anil Maurya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# BrightcoveService
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/brightcove_service`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brightcove_service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brightcove_service
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/brightcove_service. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BrightcoveService project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/brightcove_service/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "brightcove_service"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/brightcove_service.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "brightcove_service/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "brightcove_service"
+  spec.version       = BrightcoveService::VERSION
+  spec.authors       = ["Anil Maurya"]
+  spec.email         = ["anil@joshsoftware.com"]
+
+  spec.summary       = %q{BrightcoveService Wrapper for Ruby}
+  spec.description   = %q{BrightcoveService Wrapper for Ruby}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "aws-sdk-s3", "~> 1"
+  spec.add_runtime_dependency "http", "~> 3.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/brightcove_service.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'brightcove_service/ingest'
+require 'brightcove_service/video'
+require 'singleton'
+require 'http'
+
+module BrightcoveService
+  class Api
+    include Singleton
+
+    OAUTH_ENDPOINT = 'https://oauth.brightcove.com/v4/access_token'
+    API_ROOT = 'https://cms.api.brightcove.com/v1/accounts'
+    PER_PAGE = 100
+
+    def initialize
+      @client_id = ENV['BRIGHTCOVE_CLIENT_ID']
+      @client_secret = ENV['BRIGHTCOVE_CLIENT_SECRET']
+      @base_url = "#{API_ROOT}/#{ENV['BRIGHTCOVE_ACCOUNT_ID']}"
+      if [@client_id, @client_secret].any? { |c| c.to_s.empty? }
+        raise AuthenticationError, 'Missing Brightcove API credentials'
+      end
+      set_token
+    end
+
+    def create_video(params)
+      perform_action('post', 'videos', params.to_json)
+    end
+
+    def get_s3_url(video_id, filename)
+      perform_action('get', "videos/#{video_id}/upload-urls/#{filename}")
+    end
+
+    def ingest_video_and_assets(video_id, params)
+      perform_action('post', "videos/#{video_id}/ingest-requests", params)
+    end
+
+    def perform_action(request_type, url, params = {})
+      set_token if @token_expires < Time.now
+      @request_type = request_type
+      @url = "#{@base_url}/#{url}"
+      @params = params
+      response = make_request
+      return response.parse if response.code.in? [200, 201]
+      raise StandardError, response.to_s
+    end
+
+    def make_request
+      case @request_type
+      when 'post'
+        http.post(@url, body: @params)
+      when 'get'
+        http.get(@url)
+      end
+    end
+
+    def http
+      HTTP.headers(Authorization: "Bearer #{@token}", 'Content-Type': 'application/json')
+    end
+
+    private
+
+    def set_token
+      response = auth_request
+      token_response = auth_request.parse
+      return update_token(token_response) if response.status == 200
+      raise AuthenticationError, token_response.fetch('error_description')
+    end
+
+    def update_token(token_response)
+      @token = token_response.fetch('access_token')
+      @token_expires = Time.now + token_response.fetch('expires_in')
+    end
+
+    def auth_request
+      HTTP.basic_auth(user: @client_id, pass: @client_secret)
+          .post(OAUTH_ENDPOINT,
+                form: { grant_type: 'client_credentials' })
+    end
+
+    def raise_account_error
+      raise AuthenticationError, 'Token valid but not for the given account_id'
+    end
+  end
+end

data/lib/brightcove_service/base.rb

@@ -0,0 +1,18 @@
+module BrightcoveService
+  class Base
+    include ActiveModel::Validations
+
+    def add_error(e)
+      errors.add(:base, e.to_s)
+      @result = { error: error_message(e) }
+    end
+
+    def error_message(e)
+      error = JSON.parse(e.to_s)
+      return error unless error.is_a?(Array)
+      error.collect { |obj| obj['message'] }.join(', ')
+    rescue JSON::ParserError
+      return e
+    end
+  end
+end

data/lib/brightcove_service/ingest.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+require 'brightcove_service/base'
+
+module BrightcoveService
+  class Ingest < Base
+    attr_reader :result, :params
+    validate :validate_params
+
+    def initialize(params)
+      @params = params.to_h
+    end
+
+    def call
+      valid? &&
+        ingest_video
+    end
+
+    private
+
+    def ingest_video
+      @result = BrightcoveService::Api.instance.ingest_video_and_assets(params[:video_id],
+                                                                     ingest_params.to_json)
+    rescue StandardError => e
+      add_error(e)
+    end
+
+    def validate_params
+      return true if params[:video_id].present? && params[:master_url].present?
+      errors.add(:base, 'invalid params, missing video_id or master_url')
+      @result = { error: 'invalid params' }
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def ingest_params
+      @ingest_params = { master: master_record }
+      @ingest_params[:text_tracks] = text_tracks if params[:text_tracks]
+      @ingest_params[:audio_tracks] = { masters: audio_tracks } if params[:audio_tracks]
+      @ingest_params[:poster] = { url: params[:poster_url] } if params[:poster_url]
+      @ingest_params[:thumbnail] = { url: params[:thumbnail_url] } if params[:thumbnail_url]
+      @ingest_params
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def master_record
+      rec = { url: params[:master_url] }
+      return rec if params[:audio_tracks].blank?
+      rec[:audio_tracks] = audio_lang.uniq
+      rec
+    end
+
+    def audio_lang
+      params[:audio_tracks].collect do |_, tracks|
+        { language: tracks['lang'] }
+      end
+    end
+
+    def text_tracks
+      params[:text_tracks].collect do |_, tracks|
+        {
+          url: tracks['url'],
+          srclang: tracks['lang'],
+          kind: 'subtitles'
+        }
+      end
+    end
+
+    def audio_tracks
+      params[:audio_tracks].collect do |_, tracks|
+        {
+          url: tracks['url'],
+          language: tracks['lang'],
+          variant: 'descriptive'
+        }
+      end
+    end
+  end
+end

data/lib/brightcove_service/version.rb

@@ -0,0 +1,3 @@
+module BrightcoveService
+  VERSION = "0.1.0"
+end

data/lib/brightcove_service/video.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+require 'brightcove_service/base'
+require 'aws-sdk-s3'
+
+module BrightcoveService
+  class Video < Base
+    attr_reader :result, :params, :brightcove_video
+    validate :long_form_video
+
+    def initialize(params)
+      @params = params
+    end
+
+    def call
+      valid? &&
+        create_videos_on_brightcove &&
+        set_result
+    rescue StandardError => e
+      add_error(e)
+    end
+
+    private
+
+    def long_form_video
+      return true if params['assets']&.values&.any? do |a|
+        a['type'] == 'long_form_video'
+      end
+      errors.add(:base, 'long_form_video required')
+      @result = { error: 'long_form_video required' }
+    end
+
+    def create_videos_on_brightcove
+      @brightcove_video = BrightcoveService::Api.instance.create_video(brightcove_video_params)
+    end
+
+    def brightcove_video_params
+      video_params = { name: asset_title,
+                       reference_id: params[:brightcove_reference_id] }
+      video_params[:geo] = geo_params if params[:restricted] == 'true'
+      video_params[:schedule] = schedule_params if date_params?
+      video_params
+    end
+
+    def asset_title
+      params[:title_en] || params[:title_id]
+    end
+
+    def date_params?
+      params[:start_date].present? || params[:end_date].present?
+    end
+
+    def geo_params
+      {
+        restricted: params[:restricted] == 'true',
+        exclude_countries: params[:exclude_countries] == 'true',
+        countries: params[:countries].reject(&:blank?).map(&:downcase)
+      }
+    end
+
+    def schedule_params
+      {
+        starts_at: parsed_time(params[:start_date]),
+        ends_at: parsed_time(params[:end_date])
+      }
+    end
+
+    def parsed_time(time)
+      time && Time.parse(time).in_time_zone.strftime('%Y-%m-%dT%H:%M:%S.%LZ')
+    end
+
+    def set_result
+      @result = s3_urls
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def s3_urls
+      urls = []
+      params[:assets].each do |filename, values|
+        next if values['name'].blank?
+        result = BrightcoveService::Api.instance.get_s3_url(brightcove_video['id'], filename)
+        urls.push(video_id: brightcove_video['id'],
+                  presigned_url: signed_url(filename, result),
+                  request_url: result['api_request_url'],
+                  filename: filename)
+      end
+      urls
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def signed_url(_filename, result)
+      signer = Aws::S3::Presigner.new(client: s3_client(result))
+      signer.presigned_url(
+        :put_object,
+        bucket: result['bucket'],
+        key: result['object_key']
+      )
+    end
+
+    def s3_client(result)
+      Aws::S3::Client.new(
+        region:               'us-east-1',
+        access_key_id:        result['access_key_id'],
+        secret_access_key:    result['secret_access_key'],
+        session_token:        result['session_token']
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: brightcove_service
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anil Maurya
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: BrightcoveService Wrapper for Ruby
+email:
+- anil@joshsoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brightcove_service.gemspec
+- lib/brightcove_service.rb
+- lib/brightcove_service/base.rb
+- lib/brightcove_service/ingest.rb
+- lib/brightcove_service/version.rb
+- lib/brightcove_service/video.rb
+homepage: ''
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: BrightcoveService Wrapper for Ruby
+test_files: []