mux-rails 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9daf9dfa3ace722030cdfa1020cb3682771167ef24cbb91394fa59b6007a3243
+  data.tar.gz: d2f33afce8d1b13649bbee69e38912dc59cbbd82ccae9f7d926178e83b62180f
+SHA512:
+  metadata.gz: cd03523ecd957b317f4f7cc5cd2ce8cf2e07d3068124347b283f2ed1432cd3aa2b026cfec68621d5c1569431aaf52c6c798c50e0361e6119ecccead2067c3da9
+  data.tar.gz: 6a725b3b197c054f75abc3e7114b243d6058b6d1b395925099d00e7e372b537c3eb9145ff9b7432503812266b28d49707258a989aac87147ba6d5f05c0096ebd

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 asgerb
+
+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,95 @@
+# Mux::Rails
+
+![Ruby](https://github.com/asgerb/mux-rails/workflows/Ruby/badge.svg)
+
+A Rails Engine for working with [Mux](https://mux.com/).
+
+Use `Mux::Client` to create assets and `Mux::Notifications` (built on the
+`ActiveSupport::Notifications` API) to handle incoming webhook requests.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mux-rails'
+```
+
+```ruby
+# config/routes.rb
+mount Mux::Engine, at: "/mux" # provide a custom path
+```
+
+## Usage
+
+### Setup Mux tokens
+
+```ruby
+# config/initializers/mux.rb
+MuxRuby.configure do |config|
+  config.username = ENV["MUX_TOKEN_ID"]
+  config.password = ENV["MUX_TOKEN_SECRET"]
+end
+```
+
+### Creating assets
+
+Create a Mux asset by using the `Mux::Client.create_asset(url)` method, passing
+the url to the video. The method returns a Mux asset id.
+
+```ruby
+mux_asset_id = Mux::Client.create_asset("http://foo.com/bar.mp4")
+# You probably want to store mux_asset_id somewhere for future reference
+```
+
+### Deleting assets
+
+Delete an asset using the `Mux::Client.destroy_asset(asset_id)` method, passing
+the asset id:
+
+```ruby
+Mux::Client.destroy_asset("mux_asset_id")
+```
+
+### Fetching asset
+
+Fetch an asset using the `Mux::Client.get_asset(asset_id)` method, passing
+the asset id. This returns a
+[JSON object](https://docs.mux.com/docs/webhooks#section-example-response):
+
+```ruby
+asset = Mux::Client.get_asset("mux_asset_id")
+puts asset.data.status
+```
+
+### Handling webhook requests
+
+Using a subscriber with a block we can listen to incoming events from Mux and do further work:
+
+```ruby
+# config/initializers/mux.rb
+# ...
+
+Mux::Notifications.subscribe "video.asset.created" do |event|
+  # handle asset created
+  # event.object.id == mux_asset_id
+  # event.data.playback_ids.first.id
+end
+
+Mux::Notifications.subscribe "video.asset.ready" do |event|
+  # handle asset ready
+  # event.object.id == mux_asset_id
+  # event.data.playback_ids.first.id
+end
+
+Mux::Notifications.subscribe "video.asset.deleted" do |event|
+  # handle asset deleted
+  # event.object.id == mux_asset_id
+  # event.data.playback_ids.first.id
+end
+```
+
+The block is passed an event which is simply the incoming JSON (take a peek
+in [fixtures](test/fixtures) for examples) wrapped in an OpenStruct for ease of access.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Mux::Rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/mux/application_controller.rb

@@ -0,0 +1,5 @@
+module Mux
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/mux/events_controller.rb

@@ -0,0 +1,20 @@
+module Mux
+  class EventsController < ActionController::Base
+    # QUESTION: Is this the right way to handle it?
+    if ::Rails.application.config.action_controller.default_protect_from_forgery
+      skip_before_action :verify_authenticity_token
+    end
+
+    def create
+      Mux::Notifications.instrument(event)
+      head :ok
+    end
+
+    private
+
+    def event
+      event = JSON.parse(request.body.read, object_class: OpenStruct)
+      Mux::Event.new(event)
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Mux::Engine.routes.draw do
+  resources :events, only: :create
+end

data/lib/mux/client.rb

@@ -0,0 +1,31 @@
+require "mux_ruby"
+
+module Mux
+  class Client
+    class << self
+      def create_asset(url, options = {})
+        playback_policy = options.fetch(:playback_policy, "public")
+        request = MuxRuby::CreateAssetRequest.new
+        request.input = url
+        request.playback_policy = MuxRuby::PlaybackPolicy.build_from_hash(playback_policy)
+        response = assets_api.create_asset(request)
+        return response.data.id
+      end
+
+      def destroy_asset(asset_id, options = {})
+        assets_api.delete_asset(asset_id, options)
+      end
+
+      # TODO: Figure out if and how to wrap the response
+      def get_asset(asset_id, options = {})
+        assets_api.get_asset(asset_id, options)
+      end
+
+      private
+
+      def assets_api
+        @assets_api ||= MuxRuby::AssetsApi.new
+      end
+    end
+  end
+end

data/lib/mux/engine.rb

@@ -0,0 +1,5 @@
+module Mux
+  class Engine < ::Rails::Engine
+    isolate_namespace Mux
+  end
+end

data/lib/mux/event.rb

@@ -0,0 +1,12 @@
+module Mux
+  class Event
+    # QUESTION: Is there security concerns here? This implementation seems very naive ;-)
+    def initialize(payload)
+      @event = OpenStruct.new(payload)
+    end
+
+    def method_missing(method, *args, &block)
+      @event.send(method, *args, &block)
+    end
+  end
+end

data/lib/mux/notifications.rb

@@ -0,0 +1,27 @@
+require "active_support/notifications"
+
+module Mux
+  module Notifications
+    class << self
+      def instrument(event)
+        return unless event
+        ActiveSupport::Notifications.instrument "mux.#{event.type}", event
+      end
+
+      def subscribe(name, &block)
+        ActiveSupport::Notifications.subscribe %r{^mux\.#{name}}, SubscriberWrapper.call(block)
+      end
+    end
+
+    class SubscriberWrapper < Struct.new(:subscriber)
+      def self.call(subscriber)
+        new(subscriber)
+      end
+
+      def call(*args)
+        payload = args.last
+        subscriber.call(payload)
+      end
+    end
+  end
+end

data/lib/mux/rails.rb

@@ -0,0 +1,5 @@
+require "mux/engine"
+
+require "mux/notifications"
+require "mux/event"
+require "mux/client"

data/lib/mux/rails/version.rb

@@ -0,0 +1,5 @@
+module Mux
+  module Rails
+    VERSION = "0.2.0"
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: mux-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Asger Behncke Jacobsen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mux_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.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'
+- !ruby/object:Gem::Dependency
+  name: minitest-rails
+  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: sqlite3
+  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: A Rails Engine for integrating with Mux.
+email:
+- a@asgerbehnckejacobsen.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/mux/application_controller.rb
+- app/controllers/mux/events_controller.rb
+- config/routes.rb
+- lib/mux/client.rb
+- lib/mux/engine.rb
+- lib/mux/event.rb
+- lib/mux/notifications.rb
+- lib/mux/rails.rb
+- lib/mux/rails/version.rb
+homepage: https://www.github.com/asgerb/mux-rails
+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: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A Rails Engine for integrating with Mux.
+test_files: []