mux-rails 0.2.0 → 1.0.2

checksums.yaml

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

data/README.md

@@ -1,5 +1,6 @@
 # Mux::Rails
 
+![Gem Version](https://badge.fury.io/rb/mux-rails.svg)
 ![Ruby](https://github.com/asgerb/mux-rails/workflows/Ruby/badge.svg)
 
 A Rails Engine for working with [Mux](https://mux.com/).
@@ -8,17 +9,30 @@ 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:
+
+Run
+
+```bash
+bundle add mux-rails
+```
+
+or add this line to your application's Gemfile:
 
 ```ruby
 gem 'mux-rails'
 ```
 
+and run `bundle install`.
+
+Then mount the engine in your routes:
+
 ```ruby
 # config/routes.rb
 mount Mux::Engine, at: "/mux" # provide a custom path
 ```
 
+Remember to configure the webhooks at mux.com to point to `https://yourwebsite.com/mux/events`.
+
 ## Usage
 
 ### Setup Mux tokens
@@ -71,25 +85,23 @@ Using a subscriber with a block we can listen to incoming events from Mux and do
 
 Mux::Notifications.subscribe "video.asset.created" do |event|
   # handle asset created
-  # event.object.id == mux_asset_id
-  # event.data.playback_ids.first.id
+  # event.id == mux_asset_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
+  # event.id == mux_asset_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
+  # event.id == mux_asset_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.
+in [fixtures](test/fixtures) for examples) wrapped in [`Mux::Event`](lib/mux/event.rb) class based on
+`Dry::Struct`.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,31 +1,33 @@
+# frozen_string_literal: true
+
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+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')
+  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/engine.rake"
 
-load 'rails/tasks/statistics.rake'
+load "rails/tasks/statistics.rake"
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

data/app/controllers/mux/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mux
   class ApplicationController < ActionController::Base
     protect_from_forgery with: :exception

data/app/controllers/mux/events_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mux
   class EventsController < ActionController::Base
     # QUESTION: Is this the right way to handle it?
@@ -11,10 +13,10 @@ module Mux
     end
 
     private
-
-    def event
-      event = JSON.parse(request.body.read, object_class: OpenStruct)
-      Mux::Event.new(event)
-    end
+      def event
+        Mux::Event.new(
+          JSON.parse(request.body.read)
+        )
+      end
   end
 end

data/lib/mux/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "mux_ruby"
 
 module Mux
@@ -9,7 +11,7 @@ module Mux
         request.input = url
         request.playback_policy = MuxRuby::PlaybackPolicy.build_from_hash(playback_policy)
         response = assets_api.create_asset(request)
-        return response.data.id
+        response.data.id
       end
 
       def destroy_asset(asset_id, options = {})
@@ -22,10 +24,9 @@ module Mux
       end
 
       private
-
-      def assets_api
-        @assets_api ||= MuxRuby::AssetsApi.new
-      end
+        def assets_api
+          @assets_api ||= MuxRuby::AssetsApi.new
+        end
     end
   end
 end

data/lib/mux/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mux
   class Engine < ::Rails::Engine
     isolate_namespace Mux

data/lib/mux/event.rb

@@ -1,12 +1,63 @@
+# frozen_string_literal: true
+
 module Mux
-  class Event
-    # QUESTION: Is there security concerns here? This implementation seems very naive ;-)
-    def initialize(payload)
-      @event = OpenStruct.new(payload)
+  class Event < Dry::Struct
+    module Types
+      include Dry.Types()
+    end
+
+    transform_keys(&:to_sym)
+
+    attribute :id, Types::String
+    attribute :type, Types::String
+    attribute :created_at, Types::JSON::Time
+
+    attribute :object do
+      attribute :id, Types::Coercible::String
+      attribute :type, Types::Coercible::String
+    end
+
+    attribute :environment do
+      attribute :id, Types::Coercible::String
+      attribute :name, Types::Coercible::String
     end
 
-    def method_missing(method, *args, &block)
-      @event.send(method, *args, &block)
+    attribute :data do
+      attribute :id, Types::Coercible::String
+      attribute :status, Types::Coercible::String
+      attribute :created_at, Types::Coercible::Integer
+
+      attribute? :aspect_ratio, Types::Coercible::String
+      attribute? :duration, Types::Coercible::Float
+      attribute? :master_access, Types::Coercible::String
+      attribute? :max_stored_frame_rate, Types::Coercible::Float
+      attribute? :max_stored_resolution, Types::Coercible::String
+      attribute? :mp4_support, Types::Coercible::String
+
+      attribute? :stream_key, Types::Coercible::String
+      attribute? :reconnect_window, Types::Coercible::Integer
+      attribute? :latency_mode, Types::Coercible::String
+
+      attribute? :playback_ids, Types::Array do
+        attribute :id, Types::Coercible::String
+        attribute :policy, Types::Coercible::String
+      end
+
+      attribute? :tracks, Types::Array do
+        attribute? :id, Types::Coercible::String
+        attribute? :type, Types::Coercible::String
+
+        attribute? :duration, Types::Coercible::Float
+
+        # when type = "video"
+        attribute? :max_width, Types::Coercible::Integer
+        attribute? :max_height, Types::Coercible::Integer
+        attribute? :max_frame_rate, Types::Coercible::Float
+
+        # when type = "audio"
+        attribute? :max_channels, Types::Coercible::Integer
+        attribute? :max_channel_layout, Types::Coercible::String
+      end
     end
   end
 end

data/lib/mux/notifications.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/notifications"
 
 module Mux

data/lib/mux/rails/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Mux
   module Rails
-    VERSION = "0.2.0"
+    VERSION = "1.0.2"
   end
 end

data/lib/mux/rails.rb

@@ -1,5 +1,15 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+require "dry-types"
+require "mux_ruby"
+
 require "mux/engine"
+require "mux/rails/version"
+
+module Mux
+end
 
-require "mux/notifications"
-require "mux/event"
 require "mux/client"
+require "mux/event"
+require "mux/notifications"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mux-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Asger Behncke Jacobsen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: mux_ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails_config
+  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
@@ -118,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A Rails Engine for integrating with Mux.