tanshuku 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8450b3eed6f8d725bec0a20f44800db1e604f6d4e2d26e1d832fd689c53ab926
+  data.tar.gz: '08a7ad0f33eb83a5c231832a5b000a7b3bbf4d31fa78b1e480abaab16677bec2'
+SHA512:
+  metadata.gz: f2649e896ad520627924ccb3259de36bf6163d3c555609f5d40b769f91a2627a2178e324153a55cef4791a529b85d8d083f0abc67ccc3c44271b10bebc03e7de
+  data.tar.gz: b0d1f57bb3bf30a9d9344642aaf6a96163d927f3895e365c3c33f9e8d923031a8bfb1fed5aff14ab0ecb99d41e8276528f2f006b0d4beab4b16c6a8cfc032ba7

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Takumi KAGIYAMA
+
+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/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/app/controllers/tanshuku/urls_controller.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Tanshuku
+  class UrlsController < ActionController::API
+    def show
+      url = Url.find_by!(key: params[:key])
+      redirect_to url.url, status: :moved_permanently, allow_other_host: true
+    end
+  end
+end

data/app/models/tanshuku/url.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "addressable"
+require "digest/sha2"
+require "rack"
+require "securerandom"
+
+module Tanshuku
+  class Url < ActiveRecord::Base
+    MAX_URL_LENGTH = 10_000
+    URL_PATTERN = %r{\Ahttps?://\w+}
+    KEY_LENGTH = 20
+
+    validates :url, :hashed_url, :key, presence: true
+    validates :url, length: { maximum: MAX_URL_LENGTH }
+    validates :url, format: { with: URL_PATTERN }
+
+    # Don't validate uniqueness of unique attributes. Raise ActiveRecord::RecordNotUnique instead if the attributes get
+    # duplicated. Then rescue the exception and try to retry.
+    # validates :url, :hashed_url, :key, uniqueness: true
+
+    def self.shorten(original_url, retries: 0)
+      url = normalize_url(original_url)
+
+      record =
+        create_or_find_by!(hashed_url: hash_url(url)) do |r|
+          r.attributes = { url:, key: generate_key }
+        end
+
+      Tanshuku::Engine.routes.url_for(controller: "tanshuku/urls", action: :show, key: record.key)
+    rescue ActiveRecord::RecordNotUnique => e
+      if retries < 10
+        shorten(url, retries: retries + 1)
+      else
+        report_exception(exception: e, original_url:)
+        original_url
+      end
+    rescue StandardError => e
+      report_exception(exception: e, original_url:)
+      original_url
+    end
+
+    # Normalize a trailing slash, `?` for an empty query, and so on, and sort query keys.
+    def self.normalize_url(url)
+      parsed_url = Addressable::URI.parse(url)
+      parsed_url.query_values = Rack::Utils.parse_query(parsed_url.query)
+      parsed_url.normalize.to_s
+    end
+
+    def self.hash_url(url)
+      Digest::SHA512.hexdigest(url)
+    end
+
+    def self.generate_key
+      SecureRandom.alphanumeric(KEY_LENGTH)
+    end
+
+    def self.report_exception(exception:, original_url:)
+      logger.warn("Tanshuku - Failed to shorten a URL: #{exception.inspect} for #{original_url.inspect}")
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,15 @@
+en:
+  activerecord:
+    errors:
+      models:
+        tanshuku/url:
+          attributes:
+            url:
+              invalid: should start with https:// or http://
+    models:
+      tanshuku/url: Shortened URL
+    attributes:
+      tanshuku/url:
+        url: URL
+        hashed_url: hashed URL
+        key: unique key

data/config/locales/ja.yml

@@ -0,0 +1,15 @@
+ja:
+  activerecord:
+    errors:
+      models:
+        tanshuku/url:
+          attributes:
+            url:
+              invalid: は https:// または http:// で始まる必要があります
+    models:
+      tanshuku/url: 短縮URL
+    attributes:
+      tanshuku/url:
+        url: URL
+        hashed_url: ハッシュ化URL
+        key: ユニークキー

data/config/routes.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Tanshuku::Engine.routes.draw do
+  default_url_options Rails.application.routes.default_url_options
+
+  get "/:key", to: "urls#show"
+end

data/db/migrate/20230220123456_create_tanshuku_urls.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class CreateRailsUrlShortenerUrls < ActiveRecord::Migration[7.0]
+  def change
+    create_table :tanshuku_urls do |t|
+      t.text :url, null: false
+      t.string :hashed_url, null: false, limit: 128, index: { unique: true }, comment: "cf. Tanshuku::Url.hash_url"
+      t.string :key, null: false, limit: 20, index: { unique: true }, comment: "cf. Tanshuku::Url.generate_key"
+      t.datetime :created_at, null: false, precision: nil
+    end
+  end
+end

data/lib/tanshuku/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Tanshuku
+  class Engine < ::Rails::Engine
+    isolate_namespace Tanshuku
+  end
+end

data/lib/tanshuku/version.rb

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

data/lib/tanshuku.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "tanshuku/engine"
+require_relative "tanshuku/version"
+
+module Tanshuku
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: tanshuku
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kg8m
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: rubocop
+  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: rubocop-performance
+  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: rubocop-rake
+  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: rubocop-rspec
+  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: Tanshuku is a Rails engine for shortening URLs. Tanshuku generates a
+  shortened URL per a normalized original URL.
+email:
+- takumi.kagiyama@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- Rakefile
+- app/controllers/tanshuku/urls_controller.rb
+- app/models/tanshuku/url.rb
+- config/locales/en.yml
+- config/locales/ja.yml
+- config/routes.rb
+- db/migrate/20230220123456_create_tanshuku_urls.rb
+- lib/tanshuku.rb
+- lib/tanshuku/engine.rb
+- lib/tanshuku/version.rb
+homepage: https://github.com/kg8m/tanshuku
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kg8m/tanshuku
+  source_code_uri: https://github.com/kg8m/tanshuku
+  changelog_uri: https://github.com/kg8m/tanshuku/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Tanshuku is a Rails engine for shortening URLs.
+test_files: []