rails_url_shortener 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0847fa49aa14c40889c11cdf80fd32a846208112f7b1e121455f6c6258225cf8'
+  data.tar.gz: 2479208e471351f49be2f9876f33ce22cc6cf6461c62113b0d5e5c66d8bd884a
+SHA512:
+  metadata.gz: 94658a6b36105a31e1abc8ce7ac9b67913e2fecec29a834f9898224b1969ac0f593ee72c157bbe149e75a439fe5d68efaa167aebc83758fdd85eb578aef3b047
+  data.tar.gz: f40c5f6dc58ab19cd03bd714db4d68431889733579dce5e61c8990964fdc82211cc8d95e20d36d54bdc6909b7f93e871ae3648bd21ab5977123c7c93f2a71fed

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 a-chacon
+
+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,92 @@
+# RailsUrlShortener
+
+A small rails engine for short urls.
+It could be used like a url shortener or a ip logger, it is your choice.
+The app generate a short url for you and then (if you want) receive the requests and redirect to the original url.
+
+Why give your data to a third party app if you can do it by yourself?
+
+## Usage
+
+Mount the controller on your app adding the next code on your config/routes.rb:
+
+```ruby
+mount RailsUrlShortener::Engine, at: "/"
+
+```
+
+And generate the short links wherever you want using the helper method:
+
+```ruby
+short_url("https://www.github.com/a-chacon/rails_url_shortener")
+```
+
+or model method:
+
+```ruby
+RailsUrlShortener::Url.generate("https://www.github.com/a-chacon/rails_url_shortener")
+```
+
+**Then share the short link.**
+
+### Deeper
+
+By default this engine save all request made on your short url, you can use that data for some analitics or simple ip logger. So for get the data in a controller or do wherever you want you can use the Visit model related to a Url:
+```ruby
+RailsUrlShortener::Url.find_by_key("key").visits # all visits
+
+```
+Or using the model class:
+```ruby
+RailsUrlShortener::Visit.all # all in database
+```
+
+Also the Url model has a polymorphic relation with an owner that is optional. So you can relate an url whatever you want in your app adding the next relation in a model:
+```ruby
+has_many :urls, as: :owner
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_url_shortener"
+```
+
+Or install it yourself as:
+```bash
+gem install rails_url_shortener
+```
+
+Then execute:
+```bash
+bundle
+```
+
+And finally install the migrations on your project and migrate:
+```bash
+bin/rails rails_url_shortener:install:migrations db:migrate
+```
+
+If you want the initializer for configurations do:
+
+```bash
+rails generate RailsUrlShortener:initializer
+```
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## 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,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/rails_url_shortener/urls_controller.rb

@@ -0,0 +1,14 @@
+module RailsUrlShortener
+  class UrlsController < ActionController::Metal
+    include ActionController::StrongParameters
+    include ActionController::Redirecting
+    include ActionController::Instrumentation
+    include Rails.application.routes.url_helpers
+
+    def show
+      # find, if you pass the request then this is saved
+      url = Url.find_by_key(params[:key], request: request)
+      redirect_to url.url, status: :moved_permanently
+    end
+  end
+end

data/app/helpers/rails_url_shortener/application_helper.rb

@@ -0,0 +1,4 @@
+module RailsUrlShortener
+  module ApplicationHelper
+  end
+end

data/app/helpers/rails_url_shortener/urls_helper.rb

@@ -0,0 +1,28 @@
+module RailsUrlShortener
+  module UrlsHelper
+    def short_url(url, owner: nil, key: nil, expires_at: nil, category: nil, url_options: {})
+      url_object = Url.generate(
+        url,
+        owner: owner,
+        key: key,
+        expires_at: expires_at,
+        category: category
+      )
+
+      if url_object.errors.empty?
+        # This must be fixed
+        # the url_for helper must generate the url
+        # options = {
+        #   controller: "rails_url_shortener_url/urls",
+        #   action: "show",
+        #   key: url.key
+        # }.merge(url_options)
+
+        # url_for(options)
+        rails_url_shortener_url + url_object.key
+      else
+        url
+      end
+    end
+  end
+end

data/app/models/rails_url_shortener/application_record.rb

@@ -0,0 +1,5 @@
+module RailsUrlShortener
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/rails_url_shortener/url.rb

@@ -0,0 +1,88 @@
+module RailsUrlShortener
+  class Url < ApplicationRecord
+    # variables
+    attr_accessor :generating_retries, :key_length
+
+    # relations
+    belongs_to :owner, polymorphic: true, optional: true
+    has_many :visits
+
+    # validations
+    validates :key, presence: true, length: { minimum: RailsUrlShortener.minimum_key_length }, uniqueness: true
+    validates :url, presence: true, format: URI::DEFAULT_PARSER.make_regexp(%w[http https])
+
+    # exclude records in which expiration time is set and expiration time is greater than current time
+    scope :unexpired, -> { where(arel_table[:expires_at].eq(nil).or(arel_table[:expires_at].gt(::Time.current))) }
+
+    # callbacks
+    before_validation :generate_key
+    after_initialize :set_attr
+
+    ##
+    # set default instance variables values
+    def set_attr
+      @generating_retries = 0
+      @key_length = RailsUrlShortener.key_length
+    end
+
+    ##
+    # create a url object with the given params
+    #
+    # if something is wrong return the object with errors
+
+    def self.generate(url, owner: nil, key: nil, expires_at: nil, category: nil)
+      create(
+        url: url,
+        owner: owner,
+        key: key,
+        expires_at: expires_at,
+        category: category
+      )
+    end
+
+    ##
+    # find a Url object by the key param
+    #
+    # if the Url is not found an exception is raised
+    ## TODO:  and pass query params
+    def self.find_by_key!(key, request: nil)
+      # Get the token if not exipired
+      url = Url.unexpired.find_by!(key: key)
+      Visit.parse_and_save(url, request) unless request.nil?
+      url
+    end
+
+    ##
+    # find a Url object by the key param
+    #
+    # if the Url is not found the exception is rescue and
+    # return a new url object with the default url
+
+    def self.find_by_key(key, request: nil)
+      find_by_key!(key, request: request)
+    rescue ActiveRecord::RecordNotFound
+      Url.new(
+        url: RailsUrlShortener.default_redirect || '/',
+        key: 'none'
+      )
+    end
+
+    private
+
+    def key_candidate
+      (0...key_length).map { RailsUrlShortener.charset[rand(RailsUrlShortener.charset.size)] }.join
+    end
+
+    def generate_key
+      if key.nil?
+        loop do
+          # plus to the key length if after 10 attempts was not found a candidate
+          self.key_length += 1 if generating_retries >= 10
+          self.key = key_candidate
+          self.generating_retries += 1
+          break unless self.class.exists?(key: key)
+        end
+      end
+    end
+  end
+end

data/app/models/rails_url_shortener/visit.rb

@@ -0,0 +1,31 @@
+module RailsUrlShortener
+  require 'json'
+  class Visit < ApplicationRecord
+    belongs_to :url
+
+    ##
+    # Parse a request information and save
+    #
+    # Return boolean
+
+    def self.parse_and_save(url, request)
+      # browser detection
+      browser = Browser.new(request.headers['User-Agent'])
+      if !RailsUrlShortener.save_bots_visits && browser.bot?
+        false
+      else
+        # save
+        Visit.create(
+          url: url,
+          ip: request.ip,
+          browser: browser.name,
+          browser_version: browser.full_version,
+          platform: browser.platform.name,
+          platform_version: browser.platform.version,
+          bot: browser.bot?,
+          user_agent: request.headers['User-Agent']
+        )
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+RailsUrlShortener::Engine.routes.draw do
+  get '/:key', to: 'urls#show'
+end

data/db/migrate/20220407202526_create_rails_url_shortener_urls.rb

@@ -0,0 +1,22 @@
+class CreateRailsUrlShortenerUrls < ActiveRecord::Migration[7.0]
+  def change
+    create_table :rails_url_shortener_urls do |t|
+      # optional if you can link it to a user or other model
+      t.references :owner, polymorphic: true, null: true
+
+      # the real url
+      t.text :url, null: false, length: 2048
+
+      # the unique key
+      t.string :key, limit: 10, null: false
+
+      # category for short url
+      t.string :category
+
+      # valid until date for expirable urls
+      t.datetime :expires_at
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20220407202539_create_rails_url_shortener_visits.rb

@@ -0,0 +1,24 @@
+class CreateRailsUrlShortenerVisits < ActiveRecord::Migration[7.0]
+  def change
+    create_table :rails_url_shortener_visits do |t|
+      t.belongs_to    :url
+      # client ip
+      t.string        :ip
+      # browser from user_agent
+      t.string        :browser
+      # browser version from user_agent
+      t.string        :browser_version
+      # platform from user_agent
+      t.string        :platform
+      # platform version from user_agent
+      t.string        :platform_version
+      # if the request was a bot or not
+      t.boolean       :bot
+      t.string        :user_agent
+      # variable where we save all data that can be catch from the request
+      t.text          :meta
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/rails_url_shortener/rails_url_shortener_generator.rb

@@ -0,0 +1,11 @@
+require 'rails/generators'
+
+class RailsUrlShortenerGenerator < Rails::Generators::Base
+
+  source_root File.expand_path("templates", __dir__)
+
+  def copy
+    copy_file "initializer.rb", "config/initializers/rails_url_shortener.rb"
+  end
+
+end

data/lib/generators/rails_url_shortener/templates/initializer.rb

@@ -0,0 +1,11 @@
+CHARSETS = {
+  alphanum: ('a'..'z').to_a + (0..9).to_a,
+  alphacase: ('a'..'z').to_a + ('A'..'Z').to_a,
+  alphanumcase: ('A'..'Z').to_a + ('a'..'z').to_a  + (0..9).to_a
+}
+
+RailsUrlShortener.default_redirect = "/"
+RailsUrlShortener.charset = CHARSETS[:alphanumcase]
+RailsUrlShortener.key_length = 6
+RailsUrlShortener.minimum_key_length = 3
+RailsUrlShortener.save_bots_visits = false

data/lib/rails_url_shortener/engine.rb

@@ -0,0 +1,6 @@
+module RailsUrlShortener
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsUrlShortener
+    require 'browser'
+  end
+end

data/lib/rails_url_shortener/version.rb

@@ -0,0 +1,3 @@
+module RailsUrlShortener
+  VERSION = "0.1.0"
+end

data/lib/rails_url_shortener.rb

@@ -0,0 +1,37 @@
+require "rails_url_shortener/version"
+require "rails_url_shortener/engine"
+
+module RailsUrlShortener
+
+  ##
+  # constants
+  CHARSETS = {
+    alphanum: ('a'..'z').to_a + (0..9).to_a,
+    alphacase: ('a'..'z').to_a + ('A'..'Z').to_a,
+    alphanumcase: ('A'..'Z').to_a + ('a'..'z').to_a  + (0..9).to_a
+  }
+
+  ##
+  # default redirection url when the key isn't found
+  mattr_accessor :default_redirect, default: '/'
+
+  ##
+  # charset for generate keys
+  mattr_accessor :charset, default: CHARSETS[:alphanumcase]
+
+  ##
+  # default key length used by random keys
+  mattr_accessor :key_length, default: 6
+
+  ##
+  # minimum key length for custom keys
+  mattr_accessor :minimum_key_length, default: 3
+
+  ##
+  # if save bots visits on db, the detection is provided by browser gem
+  # and is described like "The bot detection is quite aggressive"
+  # so if you put this configuration like false could lose some visits to your link
+  # by default saving all requests
+  mattr_accessor :save_bots_visits, default: true
+
+end

data/lib/tasks/rails_url_shortener_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_url_shortener do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: rails_url_shortener
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- a-chacon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.2.3
+- !ruby/object:Gem::Dependency
+  name: browser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+description: A little engine for rails application that provide url shortener functions.
+email:
+- andres.ch@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/rails_url_shortener/urls_controller.rb
+- app/helpers/rails_url_shortener/application_helper.rb
+- app/helpers/rails_url_shortener/urls_helper.rb
+- app/models/rails_url_shortener/application_record.rb
+- app/models/rails_url_shortener/url.rb
+- app/models/rails_url_shortener/visit.rb
+- config/routes.rb
+- db/migrate/20220407202526_create_rails_url_shortener_urls.rb
+- db/migrate/20220407202539_create_rails_url_shortener_visits.rb
+- lib/generators/rails_url_shortener/rails_url_shortener_generator.rb
+- lib/generators/rails_url_shortener/templates/initializer.rb
+- lib/rails_url_shortener.rb
+- lib/rails_url_shortener/engine.rb
+- lib/rails_url_shortener/version.rb
+- lib/tasks/rails_url_shortener_tasks.rake
+homepage: https://www.github.com/a-chacon/rails_url_shortener
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/a-chacon/rails_url_shortener
+  source_code_uri: https://www.github.com/a-chacon/rails_url_shortener
+  changelog_uri: https://www.github.com/a-chacon/rails_url_shortener
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Rails url shortener engine.
+test_files: []