agora_rails 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04a40ffed9d5e20f48386decfc354bc5fe3883a50ab12931a91770cce0f7caeb
-  data.tar.gz: 27875a1500f997aff4d662c2291037eee9f2a7502563d43ee9580959635b91d0
+  metadata.gz: 5a3059e965098cb17acc3402b9afa3f6b03541e30f9a6535e03d6be9276f8bad
+  data.tar.gz: 0b645f35724ca861afcfbc1e3b4130e02bc1fbfad5ecfb77beb670c903df06fa
 SHA512:
-  metadata.gz: '077592d3284b50e15f8487cd3ddb310494c0e09cb67eb95f19153dffac3a41378d34c0eb98ad5ac9e9e7c372c5a58892113c51b4c1c993174c7d7c949ad2fa13'
-  data.tar.gz: c588ebe7535c4a88ff6493c4efaa29ded72a11de2e65b15672bc6e5047863d4c7500cf0dbecd82f4b2d0168085462cab867cb6b819bfb6634753ad1aa7a81ee4
+  metadata.gz: 9973c4b17d09788aae962e35eae7b2ae2c109aacce901a484795a42d7e868f3451315b501b75217f1faa710a34118388b724432debf3e0c5bf6dc9561d8f2897
+  data.tar.gz: 758847ef4240671a1fd78dac549d8c702a9420a084f3975d0852d713a4c0e46960d3902bdf7a673678a97a3f994bf57df39dd47b07c996eba21d39617d8d898e

data/README.md

@@ -45,11 +45,11 @@ DynamicKey2 requires `uid` to be an integer (i.e. not a string).
 Generate a token for a specific channel and user:
 
 ```ruby
-channel_name = 'my_channel'
-uid = 1234
+my_channel_name = 'my_channel'
+my_uid = 1234
 
 recorder = AgoraRails::CloudRecording.new
-token = recorder.generate_token(channel_name, uid)
+token = recorder.generate_token(channel_name: my_channel_name, uid: my_uid)
 ```
 You can validate the token at https://api-agora.solutions/
 
@@ -59,12 +59,20 @@ You can validate the token at https://api-agora.solutions/
 Start cloud recording for a channel:
 
 ```ruby
-channel_name = 'my_channel'
-uid = 1234
 recorder = AgoraRails::CloudRecording.new
-recorder.start(channel_name, uid)
+sid = recorder.start(channel_name: "my_channel_name", uid: 1234)
 ```
 
+Using the above method assumes that you dont plan to `query` the recording, or `stop` the recording. It will "acquire" a resource and start the recording by itself.
+If you plan to `query` the recording, or `stop` the recording, you will need to use the `resource_id` that is returned from the `acquire_resource` method, as shown below.
+
+```ruby
+recorder = AgoraRails::CloudRecording.new
+resource_id = recorder.acquire_resource(channel_name: "my_channel", uid: 1234)
+sid = recorder.start(channel_name: "my_channel", uid: 1234, resource_id: resource_id)
+```
+
+
 Stop cloud recording for a channel:
 
 If you have the CloudRecording object, you can use it to stop the recording:
@@ -77,8 +85,7 @@ If you don't have the CloudRecording object, you can use the following method to
 
 ```ruby
 recorder = AgoraRails::CloudRecording.new
-recorder.stop(channel_name, sid, uid, mode)
-
+recorder.stop(channel_name: "my_channel", resource_id: "321cba", sid: "abc123", uid: 1234, mode: "mix")
 ```
 
 

data/lib/agora_rails/cloud_recording.rb

@@ -8,7 +8,7 @@ module AgoraRails
     
     debug_output $stdout # uncomment this for debugging i.e. output to stdout
 
-    attr_accessor :app_id, :app_certificate, :customer_key, :customer_secret, :auth, :resource_id, :uid, :bucket, :access_key, :secret_key, :sid, :channel_name, :mode
+    attr_accessor :app_id, :app_certificate, :customer_key, :customer_secret, :auth, :resource_id, :uid, :bucket, :access_key, :secret_key, :sid, :channel_name, :mode, :file_prefix
 
     def initialize
       self.app_id = AgoraRails.configuration.app_id
@@ -18,9 +18,12 @@ module AgoraRails
       self.auth = { username: customer_key, password: customer_secret }
       self.uid = "#{rand(2_000_000_000..3_000_000_000)}"
       self.mode = 'mix'
+      self.file_prefix = AgoraRails.configuration.file_prefix || ''
     end
 
-    def acquire_resource(channel_name, uid = nil)
+    def acquire_resource(opts)
+      channel_name, uid = opts.values_at(:channel_name, :uid)
+      raise "Invalid Channel Name" if channel_name.nil?
       self.channel_name = channel_name
       self.uid = uid if uid
       response = self.class.post("/#{app_id}/cloud_recording/acquire",
@@ -32,17 +35,18 @@ module AgoraRails
           clientRequest: { resourceExpiredHour: 24 }
         }.to_json
       )
-      self.resource_id = handle_response(response)['resourceId']
+      handle_response(response)['resourceId']
     end
 
-    def start(channel_name, uid = nil, mode = nil, recording_config = nil)
-      raise "Invalid Channel Name" if channel_name.nil?
-      self.channel_name = channel_name
+    def start(opts = {})
+      channel_name, uid, resource_id, mode, recording_config = opts.values_at(:channel_name, :uid, :resource_id, :mode, :recording_config)
+      raise "Invalid Channel Name" if self.channel_name.nil? && channel_name.nil?
+      self.channel_name = channel_name if channel_name
       self.uid = uid if uid
       self.mode = mode if mode
-      acquire_resource(channel_name)
+      self.resource_id = resource_id || acquire_resource(channel_name: channel_name, uid: self.uid)
       recording_config ||= default_recording_config(channel_name, self.uid)
-      
+
       response = self.class.post("/#{app_id}/cloud_recording/resourceid/#{resource_id}/mode/#{self.mode}/start",
         basic_auth: auth,
         headers: { 'Content-Type' => 'application/json' },
@@ -51,16 +55,17 @@ module AgoraRails
       self.sid = handle_response(response)['sid']
     end
 
-    def stop(channel_name = nil, sid = nil, uid = nil, mode = nil)
+    def stop(opts)
+      channel_name, resource_id, sid, uid, mode = opts.values_at(:channel_name, :resource_id, :sid, :uid, :mode)
       raise "Invalid Channel Name" if channel_name.nil? && self.channel_name.nil?
+      raise "Invalid Resource ID" if resource_id.nil? && self.resource_id.nil?
       raise "Invalid SID" if sid.nil? && self.sid.nil?
       self.channel_name = channel_name if channel_name
+      self.resource_id = resource_id if resource_id
       self.sid = sid if sid
       self.uid = uid if uid
       self.mode = mode if mode
 
-      acquire_resource(self.channel_name) if self.resource_id.nil? # FIXME: should pass resource_id in because it is possible that the resource ID is expired or acquired for another channel
-
       response = self.class.post("/#{app_id}/cloud_recording/resourceid/#{self.resource_id}/sid/#{self.sid}/mode/#{self.mode}/stop",
         basic_auth: auth,
         headers: { 'Content-Type' => 'application/json' },
@@ -73,9 +78,15 @@ module AgoraRails
       handle_response(response)
     end
 
-    def query(channel_name = nil)
-      self.channel_name = channel_name if channel_name
-      response = self.class.get("/#{app_id}/cloud_recording/resourceid/#{self.resource_id}/sid/#{self.sid}/mode/#{mode}/query",
+    def query(opts)
+      resource_id, sid, mode = opts.values_at(:resource_id, :sid, :mode)
+      raise "Invalid Resource ID" if resource_id.nil? && self.resource_id.nil?
+      raise "Invalid SID" if sid.nil? && self.sid.nil?
+      self.resource_id = resource_id if resource_id
+      self.sid = sid if sid
+      self.mode = mode if mode
+
+      response = self.class.get("/#{app_id}/cloud_recording/resourceid/#{self.resource_id}/sid/#{self.sid}/mode/#{self.mode}/query",
         basic_auth: auth,
         headers: { 'Content-Type' => 'application/json' },
       )
@@ -83,7 +94,8 @@ module AgoraRails
     end
 
 
-    def generate_token(channel_name = nil, uid = nil)
+    def generate_token(opts = {})
+      channel_name, uid = opts.values_at(:channel_name, :uid)
       self.channel_name = channel_name if channel_name
       self.uid = uid if uid
 
@@ -122,7 +134,7 @@ module AgoraRails
             bucket: AgoraRails.configuration.bucket,
             accessKey: AgoraRails.configuration.access_key,
             secretKey: AgoraRails.configuration.secret_key,
-            fileNamePrefix: AgoraRails.configuration.file_prefix,
+            fileNamePrefix: file_prefix.map(&:to_s), # convert to array of strings
           },
         },
       }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: agora_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mohammad Forouzani
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: openssl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.21'
 description: Provides functionality for Agora.io token generation and cloud recording
 email:
 - mo@usechance.com