id3taginator 0.8

data/lib/id3taginator/frames/tos/entities/ownership.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Tos
+      module Entities
+        class Ownership
+          include Extensions::Comparable
+
+          attr_accessor :price_paid, :date_of_purchase, :seller
+
+          # constructor
+          #
+          # @param price_paid [String] the paid price. e.g. $19.99
+          # @param date_of_purchase [String] date of purchase in the format YYYYMMDD
+          # @param seller [String] the seller
+          def initialize(price_paid, date_of_purchase, seller)
+            @price_paid = price_paid
+            @date_of_purchase = date_of_purchase
+            @seller = seller
+          end
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/tos/entities/terms_of_use.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Tos
+      module Entities
+        class TermsOfUse
+          include Extensions::Comparable
+
+          attr_accessor :language, :text
+
+          # constructor
+          #
+          # @param language [String] the 3 character language of the terms of use
+          # @param text [String] the terms of use text
+          def initialize(language, text)
+            @language = language
+            @text = text
+          end
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/tos/owne_ownership_frame.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Tos
+      class OwnershipFrame < Id3v2Frame
+        include HasId
+
+        frame_info nil, :OWNE, :OWNE
+
+        attr_accessor :price_paid, :date_of_purchase, :seller
+
+        # builds the ownership frame
+        #
+        # @param price_paid [String] the paid price. e.g. $19.99
+        # @param date_of_purchase [String] date of purchase in the format YYYYMMDD
+        # @param seller [String] the seller
+        # @param options [Options::Options] options to use
+        # @param id3_version [Integer] the id3 version to build the frame for
+        #
+        # @return [Id3v2Frame] the resulting id3v2 frame
+        def self.build_frame(price_paid, date_of_purchase, seller, options = nil, id3_version: 3)
+          supported?('OWNE', id3_version, options)
+
+          argument_not_nil(price_paid, 'price_paid')
+          argument_not_nil(date_of_purchase, 'date_of_purchase')
+          argument_exactly_chars(date_of_purchase, 'date_of_purchase', 8)
+          argument_not_nil(seller, 'seller')
+
+          frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
+          frame.price_paid = price_paid
+          frame.date_of_purchase = date_of_purchase
+          frame.seller = seller
+          frame
+        end
+
+        def process_content(content)
+          stream = StringIO.new(content)
+          encoding = find_encoding(stream.readbyte)
+          @price_paid = read_stream_until(stream, ZERO)
+          @date_of_purchase = stream.read(8)
+          encoded_seller = stream.read
+          @seller = decode(encoded_seller, encoding)
+        end
+
+        def content_to_bytes
+          encoded_seller = encode(@seller)
+          merge(default_encoding_destination_byte, @price_paid, "\x00", @date_of_purchase, encoded_seller)
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/tos/user_terms_of_use_frame.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Tos
+      class TermsOfUseFrame < Id3v2Frame
+        include HasId
+
+        frame_info nil, :USER, :USER
+
+        attr_accessor :language, :text
+
+        # builds the terms of use frame
+        #
+        # @param language [String] the 3 character language of the terms of use
+        # @param text [String] the terms of use text
+        # @param options [Options::Options] options to use
+        # @param id3_version [Integer] the id3 version to build the frame for
+        #
+        # @return [Id3v2Frame] the resulting id3v2 frame
+        def self.build_frame(language, text, options = nil, id3_version: 3)
+          supported?('USER', id3_version, options)
+
+          argument_not_nil(language, 'language')
+          argument_exactly_chars(language, 'language', 3)
+          argument_not_nil(text, 'text')
+
+          frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
+          frame.language = language
+          frame.text = text
+          frame
+        end
+
+        def process_content(content)
+          stream = StringIO.new(content)
+          encoding = find_encoding(stream.readbyte)
+          @language = stream.read(3)
+          encoded_text = stream.read
+          @text = decode(encoded_text, encoding)
+        end
+
+        def content_to_bytes
+          encoded_text = encode(@text)
+          merge(default_encoding_destination_byte, @language, encoded_text)
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/tos_frames.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module ToSFrames
+      include Frames::Frameable
+
+      # extracts the terms of use frame (USER)
+      #
+      # @return [Frames::Tos::Entities::TermsOfUse, nil] returns the ToU Frame
+      def terms_of_use
+        frame = find_frame(Tos::TermsOfUseFrame.frame_id(@major_version, @options))
+        return nil if frame.nil?
+
+        Frames::Tos::Entities::TermsOfUse.new(frame.language, frame.text)
+      end
+
+      # sets the terms of use frame (USER)
+      #
+      # @param tou [Frames::Tos::Entities::TermsOfUse] the ToU
+      def terms_of_use=(tou)
+        set_frame_fields(Tos::TermsOfUseFrame, %i[@language @text], tou.language, tou.text)
+      end
+
+      # removes the terms of use frame
+      def remove_terms_of_use
+        @frames.delete_if { |f| f.frame_id == Tos::TermsOfUseFrame.frame_id(@major_version, @options) }
+      end
+
+      # extracts the ownership frame (OWNE)
+      #
+      # @return [Frames::Tos::Entities::Ownership, nil] returns the Ownership Frame
+      def ownership
+        frame = find_frame(Tos::OwnershipFrame.frame_id(@major_version, @options))
+        return nil if frame.nil?
+
+        Frames::Tos::Entities::Ownership.new(frame.price_paid, frame.date_of_purchase, frame.seller)
+      end
+
+      # sets the ownership frame (OWNE)
+      #
+      # @param ownership [Frames::Tos::Entities::Ownership] the Ownership
+      def ownership=(ownership)
+        set_frame_fields(Tos::OwnershipFrame, %i[@price_paid @date_of_purchase @seller],
+                         ownership.price_paid, ownership.date_of_purchase, ownership.seller)
+      end
+
+      # removes the ownership frame
+      def remove_ownership
+        @frames.delete_if { |f| f.frame_id == Tos::OwnershipFrame.frame_id(@major_version, @options) }
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/ufid/entities/ufid_info.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Ufid
+      module Entities
+        class UfidInfo
+          include Extensions::Comparable
+
+          attr_accessor :owner_id, :identifier
+
+          # constructor
+          #
+          # @param owner_id [String] the owner id
+          # @param identifier [String] the identifier bytes represented as a String (str.bytes)
+          def initialize(owner_id, identifier)
+            @owner_id = owner_id
+            @identifier = identifier
+          end
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/ufid/ufid_unique_file_identifier_frame.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Ufid
+      class UniqueFileIdentifierFrame < Id3v2Frame
+        include HasId
+
+        frame_info :UFI, :UFID, :UFID
+
+        attr_accessor :owner_id, :identifier
+
+        # builds the unique file identifier frame
+        #
+        # @param owner_id [String] the owner id
+        # @param identifier [String] the identifier bytes represented as a String (str.bytes)
+        # @param options [Options::Options] options to use
+        # @param id3_version [Integer] the id3 version to build the frame for
+        #
+        # @return [Id3v2Frame] the resulting id3v2 frame
+        def self.build_frame(owner_id, identifier, options = nil, id3_version: 3)
+          supported?('UFID', id3_version, options)
+
+          argument_not_nil(owner_id, 'owner_id')
+          argument_not_nil(identifier, 'identifier')
+
+          argument_less_than_chars(identifier, 'identifier', 64)
+
+          frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
+          frame.owner_id = owner_id
+          frame.identifier = identifier
+          frame
+        end
+
+        def process_content(content)
+          stream = StringIO.new(content)
+          @owner_id = read_stream_until(stream, ZERO)
+          @identifier = stream.read
+        end
+
+        def content_to_bytes
+          "#{@owner_id}\x00#{@identifier}"
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/ufid_frames.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module UfidFrames
+      include Frames::Frameable
+
+      # extracts the unique file identifier (UFID/UFI)
+      #
+      # @return [Array<Frames::Ufid::Entities::UfidInfo>] returns the Unique File Identifier
+      def unique_file_identifiers
+        frame = find_frames(Ufid::UniqueFileIdentifierFrame.frame_id(@major_version, @options))
+        return [] if frame.nil? || frame.empty?
+
+        frame.map { |f| Ufid::Entities::UfidInfo.new(f.owner_id, f.identifier) }
+      end
+
+      # adds a comment (UFID/UFI)
+      # Multiple ones can be added, as long as they have different owner_id
+      #
+      # @param identifier [Frames::Ufid::Entities::UfidInfo] the unique file identifier to add
+      def unique_file_identifiers=(identifier)
+        set_frame_fields_by_selector(Ufid::UniqueFileIdentifierFrame, %i[@owner_id @identifier],
+                                     ->(f) { f.owner_id == identifier.owner_id },
+                                     identifier.owner_id, identifier.identifier)
+      end
+
+      alias add_unique_file_identifier unique_file_identifiers=
+
+      # removes a unique file identifier for the specific owner_id
+      #
+      # @param owner_id [String] the owner_id
+      def remove_unique_file_identifier(owner_id)
+        @frames.delete_if do |f|
+          f.frame_id == Ufid::UniqueFileIdentifierFrame.frame_id(@major_version, @options) && f.owner_id == owner_id
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/url/entities/user_info.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Url
+      module Entities
+        class UserInfo
+          include Extensions::Comparable
+
+          attr_accessor :description, :url
+
+          # constructor
+          #
+          # @param description [String] the description
+          # @param url [String] the url
+          def initialize(description, url)
+            @description = description
+            @url = url
+          end
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/url/wcom_commercial_url_frame.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Url
+      class CommercialUrlFrame < Id3v2Frame
+        include HasId
+
+        frame_info :WCM, :WCOM, :WCOM
+
+        attr_accessor :url
+
+        # builds the commercial use frame
+        #
+        # @param url [String] the url
+        # @param options [Options::Options] options to use
+        # @param id3_version [Integer] the id3 version to build the frame for
+        #
+        # @return [Id3v2Frame] the resulting id3v2 frame
+        def self.build_frame(url, options = nil, id3_version: 3)
+          supported?('WCOM', id3_version, options)
+
+          argument_not_nil(url, 'url')
+
+          frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
+          frame.url = url
+          frame
+        end
+
+        def process_content(content)
+          @url = content
+        end
+
+        def content_to_bytes
+          @url
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/url/wcop_copyright_url_frame.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Url
+      class CopyrightUrlFrame < Id3v2Frame
+        include HasId
+
+        frame_info :WCP, :WCOP, :WCOP
+
+        attr_accessor :url
+
+        # builds the copyright url frame
+        #
+        # @param url [String] the url
+        # @param options [Options::Options] options to use
+        # @param id3_version [Integer] the id3 version to build the frame for
+        #
+        # @return [Id3v2Frame] the resulting id3v2 frame
+        def self.build_frame(url, options = nil, id3_version: 3)
+          supported?('WCOP', id3_version, options)
+
+          argument_not_nil(url, 'url')
+
+          frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
+          frame.url = url
+          frame
+        end
+
+        def process_content(content)
+          @url = content
+        end
+
+        def content_to_bytes
+          @url
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/url/woaf_official_file_webpage_frame.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Url
+      class OfficialFileWebpageFrame < Id3v2Frame
+        include HasId
+
+        frame_info :WAF, :WOAF, :WOAF
+
+        attr_accessor :url
+
+        # builds the official file webpage frame
+        #
+        # @param url [String] the url
+        # @param options [Options::Options] options to use
+        # @param id3_version [Integer] the id3 version to build the frame for
+        #
+        # @return [Id3v2Frame] the resulting id3v2 frame
+        def self.build_frame(url, options = nil, id3_version: 3)
+          supported?('WOAF', id3_version, options)
+
+          argument_not_nil(url, 'url')
+
+          frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
+          frame.url = url
+          frame
+        end
+
+        def process_content(content)
+          @url = content
+        end
+
+        def content_to_bytes
+          @url
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/url/woar_official_artist_webpage_frame.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Url
+      class OfficialArtistWebpageFrame < Id3v2Frame
+        include HasId
+
+        frame_info :WAR, :WOAR, :WOAR
+
+        attr_accessor :url
+
+        # builds the official artist webpage frame
+        #
+        # @param url [String] the url
+        # @param options [Options::Options] options to use
+        # @param id3_version [Integer] the id3 version to build the frame for
+        #
+        # @return [Id3v2Frame] the resulting id3v2 frame
+        def self.build_frame(url, options = nil, id3_version: 3)
+          supported?('WOAR', id3_version, options)
+
+          argument_not_nil(url, 'url')
+
+          frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
+          frame.url = url
+          frame
+        end
+
+        def process_content(content)
+          @url = content
+        end
+
+        def content_to_bytes
+          @url
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/url/woas_official_source_webpage_frame.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Url
+      class OfficialSourceWebpageFrame < Id3v2Frame
+        include HasId
+
+        frame_info :WAS, :WOAS, :WOAS
+
+        attr_accessor :url
+
+        # builds the official source webpage frame
+        #
+        # @param url [String] the url
+        # @param options [Options::Options] options to use
+        # @param id3_version [Integer] the id3 version to build the frame for
+        #
+        # @return [Id3v2Frame] the resulting id3v2 frame
+        def self.build_frame(url, options = nil, id3_version: 3)
+          supported?('WOAS', id3_version, options)
+
+          argument_not_nil(url, 'url')
+
+          frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
+          frame.url = url
+          frame
+        end
+
+        def process_content(content)
+          @url = content
+        end
+
+        def content_to_bytes
+          @url
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/url/wors_official_radio_station_homepage_frame.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Url
+      class OfficialAudioRadioStationHomepageFrame < Id3v2Frame
+        include HasId
+
+        frame_info nil, :WORS, :WORS
+
+        attr_accessor :url
+
+        # builds the official audio ration station homepage frame
+        #
+        # @param url [String] the url
+        # @param options [Options::Options] options to use
+        # @param id3_version [Integer] the id3 version to build the frame for
+        #
+        # @return [Id3v2Frame] the resulting id3v2 frame
+        def self.build_frame(url, options = nil, id3_version: 3)
+          supported?('WORS', id3_version, options)
+
+          argument_not_nil(url, 'url')
+
+          frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
+          frame.url = url
+          frame
+        end
+
+        def process_content(content)
+          @url = content
+        end
+
+        def content_to_bytes
+          @url
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/url/wpay_payment_url_frame.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Url
+      class PaymentUrlFrame < Id3v2Frame
+        include HasId
+
+        frame_info nil, :WPAY, :WPAY
+
+        attr_accessor :url
+
+        # builds the payment url frame
+        #
+        # @param url [String] the url
+        # @param options [Options::Options] options to use
+        # @param id3_version [Integer] the id3 version to build the frame for
+        #
+        # @return [Id3v2Frame] the resulting id3v2 frame
+        def self.build_frame(url, options = nil, id3_version: 3)
+          supported?('WPAY', id3_version, options)
+
+          argument_not_nil(url, 'url')
+
+          frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
+          frame.url = url
+          frame
+        end
+
+        def process_content(content)
+          @url = content
+        end
+
+        def content_to_bytes
+          @url
+        end
+      end
+    end
+  end
+end

data/lib/id3taginator/frames/url/wpub_official_publisher_webpage_frame.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Id3Taginator
+  module Frames
+    module Url
+      class OfficialPublisherWebpageFrame < Id3v2Frame
+        include HasId
+
+        frame_info :WPB, :WPUB, :WPUB
+
+        attr_accessor :url
+
+        # builds the official publisher webpage frame
+        #
+        # @param url [String] the url
+        # @param options [Options::Options] options to use
+        # @param id3_version [Integer] the id3 version to build the frame for
+        #
+        # @return [Id3v2Frame] the resulting id3v2 frame
+        def self.build_frame(url, options = nil, id3_version: 3)
+          supported?('WPUB', id3_version, options)
+
+          argument_not_nil(url, 'url')
+
+          frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
+          frame.url = url
+          frame
+        end
+
+        def process_content(content)
+          @url = content
+        end
+
+        def content_to_bytes
+          @url
+        end
+      end
+    end
+  end
+end