vixen_rename 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0dadad9ed8d1af50a6aa18ef38af070b2b72a9eb3380b32a7bcb97a8f1eb0c83
+  data.tar.gz: be61172541539cf55218b175c985b11619668fb1bcfdaef90cd90d234202b647
+SHA512:
+  metadata.gz: 567bf4704726f323129139676cf407159172280f07fddf7cf37dc8e2cedb01c5c4cc19974f73347f5dbd420f59bb38fe2fb4984193eb7db384d758b63fdce944
+  data.tar.gz: d7aada12e84e04aad6e2ff6ccfa5b35a140d20f95913bcd1d90531f6600e6666f8deebd0d2a729be69862e34511e2ff972b5260a79bd3dba295c197161263a06

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in vixen_rename.gemspec
+gemspec
+
+gem "webmock", "~> 3.14"
+
+
+
+gem "thor", "~> 1.1"

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    vixen_rename (0.1.0)
+      colorize (~> 0.8.1)
+      file_scan (~> 0.1.0)
+      httparty (~> 0.19.0)
+      rake (~> 13.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    file_scan (0.1.0)
+      colorize (~> 0.8.1)
+      rake (~> 13.0)
+      rubocop (~> 1.7)
+    hashdiff (1.0.1)
+    httparty (0.19.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    multi_xml (0.6.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.9.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    unicode-display_width (2.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  pry (~> 0.14.1)
+  rspec (~> 3.10)
+  rubocop (~> 1.7)
+  thor (~> 1.1)
+  vixen_rename!
+  webmock (~> 3.14)
+
+BUNDLED WITH
+   2.2.27

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 anujchandra
+
+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,39 @@
+# VixenRename
+
+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/vixen_rename`. 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 'vixen_rename'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install vixen_rename
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, 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]/vixen_rename.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "vixen_rename"
+
+# 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/exe/vixen_rename

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+$pwd = Dir.pwd
+
+require "thor"
+require "vixen_rename"
+
+VixenRename::Cli.start ARGV

data/lib/vixen_rename/cli.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module VixenRename
+  class Cli < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "rename file_or_path", "Rename files in a directory"
+    long_desc <<-LONGDESC
+    `vixen_rename rename` will rename file(s) given to the cli
+
+    You can pass a single file or a directory containing files
+
+    By default the gem will not touch the files. The only way to
+    rename files is by passing a `--commit` flag.
+
+    > $ vixen_rename rename CHANNELS_102217_480P.mp4
+    > $ vixen_rename rename .
+    LONGDESC
+    option :commit, alias: :c, type: :boolean, default: false
+
+    def rename(location)
+      opts = options.transform_keys(&:to_sym)
+      Client.new(location, **opts).convert
+    end
+  end
+end

data/lib/vixen_rename/client.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module VixenRename
+  # Top Level Client
+  class Client
+    include VixenRename::Util
+
+    def initialize(location, **opts)
+      @location = location
+      @net = Net.new
+      @verbose = opts[:commit] != true
+    end
+
+    def convert
+      convert_file if File.file? @location
+
+      convert_files_in_dir if File.directory? @location
+    end
+
+    private
+
+    def convert_file
+      Dir.chdir(File.dirname(@location)) do
+        old_file_name = File.basename(@location)
+        new_filename, release_date = FileParser::Scene.new(@net).process(old_file_name)
+        return if new_filename.nil? || release_date.nil?
+
+        rename(old_file_name, new_filename, release_date, verbose: @verbose)
+        new_filename
+      end
+    end
+
+    def convert_files_in_dir
+      scanner.each do |file|
+        new_filename, release_date = FileParser::Scene.new(@net).process(file)
+        next if new_filename.nil? || release_date.nil?
+
+        rename(file, new_filename, release_date, verbose: @verbose)
+      rescue VixenAPIError => e
+        print "Error: #{e}\n"
+      end
+    end
+
+    # @return [FileScanner::Client]
+    def scanner
+      @scanner ||= FileScanner.new(@location, { nested: @verbose, extension: "*.mp4" })
+    end
+  end
+end

data/lib/vixen_rename/file_parser.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module VixenRename
+  module FileParser
+
+    # rubocop:disable Lint/MixedRegexpCaptureTypes
+    UNPROCESSED_SCENE_TYPE_1_REGEX = /
+    ^                                                                   # Start of String
+    (?<site>(DEEPER|VIXEN|BLACKEDRAW|BLACKED|TUSHYRAW|TUSHY|CHANNELS))  # Site Name
+    _                                                                   # Separator
+    (?<video_id>\d*)                                                    # Video ID
+    _\d{3,4}P                                                           # Video Resolution
+    .mp4                                                                # File Extension
+    $                                                                   # End of String
+    /x.freeze
+
+    UNPROCESSED_SCENE_TYPE_2_REGEX = /
+    ^                                                                  # Start of String
+    (?<site>(DEEPER|VIXEN|BLACKEDRAW|BLACKED|TUSHYRAW|TUSHY|CHANNELS)) # Site Name
+    _                                                                  # Separator
+    (?<video_id>\d{6})                                                 # Video ID
+    -.*_                                                               # Actor First Name
+    \d{3,4}P                                                           # Resolution
+    .mp4                                                               # File Extension
+    $                                                                  # End of String
+    /x.freeze
+    # rubocop:enable Lint/MixedRegexpCaptureTypes
+
+    # Class to fetch details for a scene using the filename
+    class Scene
+
+      # @param [VixenRename::Net] net
+      def initialize(net)
+        @net = net
+      end
+
+      # @param [String] file Name of file
+      def process(file)
+        @file = file
+
+        return if match.nil?
+
+        hash = search(match[:video_id], match[:site])
+        return filename(hash, File.extname(@file)), hash[:release_date]
+      end
+
+      private
+
+      def match
+        return @file.match(UNPROCESSED_SCENE_TYPE_1_REGEX) unless @file.match(UNPROCESSED_SCENE_TYPE_1_REGEX).nil?
+
+        @file.match(UNPROCESSED_SCENE_TYPE_2_REGEX) unless @file.match(UNPROCESSED_SCENE_TYPE_2_REGEX).nil?
+      end
+
+      def search(video_id, site)
+        @net.get_video_by_id(video_id, site)
+      end
+
+      def filename(hash, extension)
+        "#{hash[:models].join(", ")} [T] #{hash[:title].strip} [S] #{hash[:site].strip} [ID] #{hash[:video_id]}#{extension}"
+      end
+
+    end
+
+  end
+end

data/lib/vixen_rename/net.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module VixenRename
+  # Interact with a VixenGroup API
+  #
+  # Example:
+  # VixenRename::Net.new.get_video_by_id 100415, 'VIXEN'
+  class Net
+    include HTTParty
+    base_uri "https://www.vixen.com"
+
+    # @param [Integer] video_id
+    # @param [String] site
+    # @return [Hash]
+    def get_video_by_id(video_id, site)
+      @video_id = video_id
+      @site = site
+      resp = self.class.post("/graphql", body: body, headers: headers)
+      raise VixenAPIError, resp.code, resp.parsed_response, "HTTP Failed" if resp.code != 200
+
+      {
+        video_id: resp.dig("data", "findOneVideo", "videoId").to_i,
+        title: resp.dig("data", "findOneVideo", "title"),
+        release_date: Time.parse(resp.dig("data", "findOneVideo", "releaseDate")),
+        models: resp.dig("data", "findOneVideo", "modelsSlugged").map { |m| m["name"] },
+        site: site
+      }
+    end
+
+    private
+
+    # Generate the POST body
+    #
+    # @return [JSON]
+    def body
+      {
+        "operationName": "getVideo",
+        "variables": {
+          "videoId": @video_id,
+          "site": @site
+        },
+        "query": "query getVideo($videoId: ID, $site: Site) { findOneVideo(input: { videoId: $videoId, site: $site })" \
+                 "{id: uuid videoId title releaseDate modelsSlugged: models{name}}}"
+      }.to_json
+    end
+
+    # @return [Hash{Symbol->String (frozen)}] headers
+    def headers
+      {
+        "content-type": "application/json"
+      }
+    end
+  end
+end
+
+
+# VixenRename::Net.new.get_video_by_id 100415, 'VIXEN'

data/lib/vixen_rename/util.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module VixenRename
+  module Util # :nodoc:
+
+    # rubocop:disable Metrics/MethodLength
+    # @param [String] old_name
+    # @param [String] new_name
+    # @param [Date] date
+    # @param [Boolean] verbose
+    def rename(old_name, new_name, date, verbose: true)
+      if verbose
+        print "File Match: #{old_name.to_s.colorize(:red)} " \
+              "can be renamed to #{new_name.to_s.colorize(:green)}\n"
+      else
+        begin
+          # Rename the file
+          File.rename(old_name, new_name)
+
+          # Update the modified time of the file to the date the scene was
+          # released and keep the accessed time as it is
+          File.utime(File.atime(new_name), date, new_name)
+          print "File Match: #{old_name.to_s.colorize(:red)} " \
+                "renamed to #{new_name.to_s.colorize(:green)}\n"
+        rescue Errno::ENAMETOOLONG
+          print "Generated name is too long. Skip processing.\n"
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/vixen_rename/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module VixenRename
+  VERSION = "0.1.0"
+end

data/lib/vixen_rename.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "colorize"
+require "file_scanner"
+require "fileutils"
+require "httparty"
+require "json"
+
+module VixenRename
+  class Error < StandardError; end
+
+  # Exception class when a Vixen API sends a non-200 response
+  class VixenAPIError < StandardError
+    # @param [Integer] code Response Code
+    # @param [Hash] body Response body
+    # @param [nil] msg Error Message
+    def initialize(code, body, msg = nil)
+      @code = code
+      @body = body
+      super(msg)
+    end
+  end
+
+  def self.new(location)
+    Client.new(location)
+  end
+end
+
+require_relative "vixen_rename/file_parser"
+require_relative "vixen_rename/net"
+require_relative "vixen_rename/util"
+require_relative "vixen_rename/version"
+
+require_relative "vixen_rename/client"
+require_relative "vixen_rename/cli"

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: vixen_rename
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- c477y
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: file_scan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+description: Library to rename files from Vixen, Blacked, BlackedRaw, Tushy, TushyRaw
+  and Deeper.
+email:
+- c477y@protonmail.com
+executables:
+- vixen_rename
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/vixen_rename
+- lib/vixen_rename.rb
+- lib/vixen_rename/cli.rb
+- lib/vixen_rename/client.rb
+- lib/vixen_rename/file_parser.rb
+- lib/vixen_rename/net.rb
+- lib/vixen_rename/util.rb
+- lib/vixen_rename/version.rb
+homepage: https://github.com/c477y/vixen_rename
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/c477y/vixen_rename
+  source_code_uri: https://github.com/c477y/vixen_rename
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: CLI to rename videos downoaded from Vixen group
+test_files: []