short_rails 1.0.0 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YzQ4MTQwZmY4MTI1NDA2MDBlMjA4NmRjMjJiNzJjZjM4OTdmZGE1ZQ==
-  data.tar.gz: !binary |-
-    YTNlNzhjMDhjNmFmYWExMGJmN2MxNmU2YWZjZmQzOGUwMDM2OGFjYw==
+SHA256:
+  metadata.gz: 312cb7ab3456051bd02ce370632315213846dd1eea8a68627a291f353a84c6b8
+  data.tar.gz: 58a0be9855654507bda85a1b8afc4f4aefa8a10a39ce96b2ed98c6fb389260e3
 SHA512:
-  metadata.gz: !binary |-
-    YjJhMTA3YTQ4NWQ1NGE0MTY5YzIyZTQ2ZWNmMWZlOGU4YTA4NGI5MmJhZDhh
-    N2M5OGM3NDcyNjBjYTdmNGQwZmZkNmFkNWU0OGQyODI2MzgzMGYyMGQxYjVl
-    MzBmMjRlZDUxNjdhMWJlMDQzYTAyMjY5ZWQyMmVjNDljMGIzYTY=
-  data.tar.gz: !binary |-
-    M2Q5OGRlYjZmY2QxZmFmODcyMjE2NzE4MjMwOTk0MWI4Y2MwZGVhYTgwMDkx
-    NmUxZGJjYTBkZTY3Y2FkMDI5ZDNhZjgzMjlhNWRjNjU3MmY1ZDNmYWM2OTkz
-    M2QxMTI4MmEzMjFjMjY3NjkwZDJmZWNjMmJiOTliMjQ1YzIzMjY=
+  metadata.gz: 314a394f93cbb5a7eb7a81d5dcd17be79679af8370c8587b8205252d02d53ff3ae4c8b003c0f07d0e5f784b0cd3fa4cb89e1ca7439601e564a2da6c7c9042a93
+  data.tar.gz: 71f8c517ddf90c88cfce8367a5141a4686eb666d49dc32f675ea596858f297cb70b5cd8ae9a43212f00c5c60f2c0413e5b570b6e52916d2a3b62661e28f8c005

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Sourcepole
+Copyright 2012-2021 Sourcepole
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,65 +1,82 @@
 # ShortRails
 
-URL shortener for Rails.
+URL shortener for Rails 6.
 
-## Installation:
+## Installation
 
 Add this line to your application's Gemfile:
-
-    gem 'short_rails'
+```ruby
+gem 'short_rails'
+```
 
 And then execute:
-
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
-
-    $ gem install short_rails
+```bash
+$ gem install short_rails
+```
 
 ## Configuration
 
-Mount engine in config/routes.rb
-
-    Rails.application.routes.draw do
-      mount ShortRails::Engine => "/s"
-    end
+Mount engine in `config/routes.rb`:
+```ruby
+Rails.application.routes.draw do
+  mount ShortRails::Engine => "/s"
+end
+```
+
+Copy engine migrations to application:
+```bash
+$ bin/rails short_rails:install:migrations
+$ bin/rails db:migrate
+```
+
+Configure optional host whitelist (default: `nil`, disabled) in initializer (e.g. `config/initializers/short_rails.rb`):
+```ruby
+ShortRails.setup do |config|
+  config.host_whitelist = ['example.com', '127.0.0.1']
+end
+```
 
-Copy engine migrations to application
-
-    $ rake short_rails:install:migrations
-    $ rake db:migrate
+## Usage
 
-Run standalone dummy app
+* `POST /s`: Create short URL
+  
+  Submit data:
+  * `base_url`: base URL without parameters (e.g. `http://example.com/path`)
+  * `base_url_short_param`: optional parameter for short id on redirect (e.g. `s`)
+  * URL parameters
 
-    $ cd test/dummy/
-    $ rails s
+  Example request:
+  ```bash
+  curl -F base_url=http://example.com/path -F base_url_short_param=s -F x=1 -F y=2 http://localhost:3000/s
+  ```
 
-    http://localhost:3000/s
+  Returns short id as text (e.g. `abc123`)
 
-## Usage
+* `GET /s/abc123`: Open short URL
 
-* POST /s
-    submit data:
-      - 'base_url': base URL without parameters (e.g. "http://example.com/path")
-      - 'base_url_short_param': optional parameter for short id on redirect (e.g. "s")
-      - url parameters
+  If `base_url_short_param` has been set, redirect to `<base_url>?<base_url_short_param>=<short id>` (e.g. `http://example.com/path?s=abc123`), otherwise redirect to full URL.
 
-    returns short id (e.g. 'abc123')
+* `GET /s/abc123/params`: Get full URL parameters as JSON
 
-* GET /s/abc123
-    if 'base_url_short_param' has been set, redirect to 
+* `GET /s/abc123/qrcode`: Get QR code as PNG image
 
-      "<base_url>?<base_url_short_param>=<short id>"
-      (e.g. "http://example.com/path?s=abc123")
+  Parameters:
+  * `width` (optional): image width (max 2048), will be clamped to minimum QR code width
+  * `height` (optional): image height (max 2048), will be clamped to minimum QR code height
 
-    else redirect to full URL
+## Development
 
-* GET /s/abc123/params
-    get full URL parameters as JSON
+Run standalone dummy app at http://localhost:3000/s:
+```bash
+$ cd test/dummy/
+$ bin/rails s
+```
 
-* GET /s/abc123/qrcode
-    parameters:
-      - 'width' (optional): image width (max 2048), will be clamped to minimum QR code width
-      - 'height' (optional): image height (max 2048), will be clamped to minimum QR code height
+## License
 
-    get QR code as PNG image
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,40 +1,18 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ShortRails'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
+require "bundler/setup"
 
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
+load "rails/tasks/statistics.rake"
 
-Bundler::GemHelper.install_tasks
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
 end
 
-
-task :default => :test
+task default: :test

data/app/assets/config/short_rails_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/short_rails .css

data/app/assets/stylesheets/short_rails/application.css

@@ -3,11 +3,13 @@
  * listed below.
  *
  * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
  *
- * You're free to add application-wide styles to this file and they'll appear at the top of the
- * compiled file, but it's generally better to create a new file per style scope.
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
  *
- *= require_self
  *= require_tree .
+ *= require_self
  */

data/app/controllers/short_rails/short_urls_controller.rb

@@ -1,16 +1,19 @@
-require_dependency "short_rails/application_controller"
-
 module ShortRails
   class ShortUrlsController < ApplicationController
+    skip_before_action :verify_authenticity_token
 
     # GET ':id'
     # redirect to base URL
     def show
       short_url = ShortUrl.find_by_short(params[:short])
+      if short_url.nil?
+        head :not_found
+        return
+      end
 
       if short_url.url_short_param.nil?
         # redirect to full URL
-        query_params = short_url.params
+        query_params = short_url.params.permit!
       else
         # redirect to base URL with short param
         query_params = {short_url.url_short_param => short_url.short}
@@ -24,15 +27,15 @@ module ShortRails
     def create
       begin
         short = SecureRandom.base64(6).tr("+/=", "xyz").downcase
-      end while ShortUrl.where(:short => short).exists?
+      end while ShortUrl.where(short: short).exists?
 
       url_params = params.except(:action, :controller, :base_url, :base_url_short_param)
-      short_url = ShortUrl.new(:short => short, :url => params[:base_url], :url_short_param => params[:base_url_short_param], :params => url_params)
+      short_url = ShortUrl.new(short: short, url: params[:base_url], params: url_params, url_short_param: params[:base_url_short_param])
       if short_url.save
         # return short id
-        render :text => short
+        render plain: short
       else
-        head :no_content
+        head :bad_request
       end
     end
 
@@ -40,24 +43,28 @@ module ShortRails
     # get parameters for full URL
     def parameters
       short_url = ShortUrl.find_by_short(params[:short])
+      if short_url.nil?
+        head :not_found
+        return
+      end
 
-      render :text => short_url.params.to_json
+      render json: short_url.params
     end
 
     # GET ':id/qrcode'
     # get QR code containing this short URL
     def qrcode
-      require 'rqrcode_png'
+      require 'rqrcode'
 
       if ShortUrl.find_by_short(params[:short]).nil?
-        render :text => "ERROR: Could not generate QR code", :status => :bad_request
+        render plain: "ERROR: Could not generate QR code", status: :not_found
         return
       end
 
       width = params[:width].to_i
       height = params[:height].to_i
       if width > 2048 || height > 2048
-        render :text => "ERROR: Requested image size is too large", :status => :bad_request
+        render plain: "ERROR: Requested image size is too large", status: :bad_request
         return
       end
 
@@ -66,24 +73,37 @@ module ShortRails
       version = 3
       while qr.nil? && version < 40
         begin
-          qr = RQRCode::QRCode.new( short_url_url, :size => version, :level => :h )
+          qr = RQRCode::QRCode.new(short_url_url, size: version, level: :h)
         rescue
           # current version has not enough capacity, try next version
           version += 1
         end
       end
       if qr.nil?
-        render :text => "ERROR: Could not generate QR code", :status => :bad_request
+        render plain: "ERROR: Could not generate QR code", status: :bad_request
         return
       end
-      qr_image = qr.to_img
 
       qr_size = 17 + 4 * version
-      # default size is QR code pixels with a border of 1/10 that size
-      img_size =(qr_size + qr_size/10 * 2)
-      # clamp to min default size
-      width = [width, img_size].max
-      height = [height, img_size].max
+      # min size is QR code pixels with a border of 4 QR code pixels
+      border_modules = 4
+      min_size = (qr_size + border_modules * 2)
+      if params[:width].nil? && params[:height].nil?
+        # default size with 3 image pixels per QR code pixel
+        img_size = 3 * min_size
+        width = img_size
+        height = img_size
+      else
+        # clamp to min default size
+        width = [width, min_size].max
+        height = [height, min_size].max
+        img_size = [width, height].min
+      end
+
+      qr_image = qr.as_png(
+        size: img_size,
+        border_modules: border_modules
+      )
 
       if width > img_size || height > img_size
         # calculate image size to fit scaled QR code to requested size
@@ -100,8 +120,7 @@ module ShortRails
         end
       end
 
-      send_data qr_image.to_string, :type => 'image/png', :disposition => 'inline', :filename => "#{params[:short]}.png"
+      send_data qr_image.to_s, type: 'image/png', disposition: 'inline', filename: "#{params[:short]}.png"
     end
-
   end
 end

data/app/jobs/short_rails/application_job.rb

@@ -0,0 +1,4 @@
+module ShortRails
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/short_rails/application_mailer.rb

@@ -0,0 +1,6 @@
+module ShortRails
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/short_rails/application_record.rb

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

data/app/models/short_rails/short_url.rb

@@ -1,7 +1,16 @@
 module ShortRails
-  class ShortUrl < ActiveRecord::Base
-    attr_accessible :short, :url, :url_short_param, :params
-
+  class ShortUrl < ApplicationRecord
     serialize :params
+
+    validate :url_host_in_whitelist
+
+    def url_host_in_whitelist
+      unless ShortRails.host_whitelist.nil?
+        uri = URI.parse(url)
+        unless ShortRails.host_whitelist.include?(uri.host)
+          errors.add(:url, "is not in host whitelist")
+        end
+      end
+    end
   end
 end

data/app/views/layouts/short_rails/application.html.erb

@@ -1,10 +1,11 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>ShortRails</title>
-  <%= stylesheet_link_tag    "short_rails/application", :media => "all" %>
-  <%= javascript_include_tag "short_rails/application" %>
+  <title>Short rails</title>
   <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "short_rails/application", media: "all" %>
 </head>
 <body>
 

data/config/routes.rb

@@ -1,7 +1,7 @@
 ShortRails::Engine.routes.draw do
-  match ':short' => 'short_urls#show', :as => :short_url
-  match ':short/params' => 'short_urls#parameters', :as => :short_url_params
-  match ':short/qrcode' => 'short_urls#qrcode', :as => :short_url_qrcode
+  get ':short' => 'short_urls#show', as: :short_url
+  get ':short/params' => 'short_urls#parameters', as: :short_url_params
+  get ':short/qrcode' => 'short_urls#qrcode', as: :short_url_qrcode
 
-  root :to => 'short_urls#create', :via => :post
+  root to: 'short_urls#create', via: :post
 end

data/db/migrate/{20121123124825_create_short_rails_short_urls.rb → 20211116084848_create_short_rails_short_urls.rb}

@@ -1,9 +1,10 @@
-class CreateShortRailsShortUrls < ActiveRecord::Migration
+class CreateShortRailsShortUrls < ActiveRecord::Migration[6.1]
   def change
     create_table :short_rails_short_urls do |t|
       t.string :short, :null => false, :index => true
       t.string :url, :null => false
       t.text :params
+      t.string :url_short_param
 
       t.timestamps
     end

data/lib/short_rails/version.rb

@@ -1,3 +1,3 @@
 module ShortRails
-  VERSION = "1.0.0"
+  VERSION = '2.0.0'
 end

data/lib/short_rails.rb

@@ -1,4 +1,11 @@
+require "short_rails/version"
 require "short_rails/engine"
 
 module ShortRails
+  mattr_accessor :host_whitelist
+  @@host_whitelist = nil
+
+  def self.setup
+    yield self
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: short_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Mathias Walker
@@ -9,51 +9,43 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.13
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
+        version: 6.1.4
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.13
-- !ruby/object:Gem::Dependency
-  name: rqrcode_png
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.4.1
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rqrcode
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '2.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: URL shortener for Rails
+        version: '2.1'
+description: URL shortener for Rails 6
 email:
 - info@sourcepole.ch
 executables: []
@@ -63,58 +55,25 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/javascripts/short_rails/application.js
+- app/assets/config/short_rails_manifest.js
 - app/assets/stylesheets/short_rails/application.css
 - app/controllers/short_rails/application_controller.rb
 - app/controllers/short_rails/short_urls_controller.rb
 - app/helpers/short_rails/application_helper.rb
+- app/jobs/short_rails/application_job.rb
+- app/mailers/short_rails/application_mailer.rb
+- app/models/short_rails/application_record.rb
 - app/models/short_rails/short_url.rb
 - app/views/layouts/short_rails/application.html.erb
 - config/routes.rb
-- db/migrate/20121123124825_create_short_rails_short_urls.rb
-- db/migrate/20130108094545_add_url_short_param_to_short_urls.rb
+- db/migrate/20211116084848_create_short_rails_short_urls.rb
 - lib/short_rails.rb
 - lib/short_rails/engine.rb
 - lib/short_rails/version.rb
 - lib/tasks/short_rails_tasks.rake
-- test/dummy/README.rdoc
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/db/development.sqlite3
-- test/dummy/db/migrate/20121123133344_create_short_rails_short_urls.short_rails.rb
-- test/dummy/db/migrate/20130108094709_add_url_short_param_to_short_urls.short_rails.rb
-- test/dummy/db/schema.rb
-- test/dummy/log/development.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/script/rails
-- test/integration/navigation_test.rb
-- test/short_rails_test.rb
-- test/test_helper.rb
-homepage: http://www.sourcepole.ch
-licenses: []
+homepage: https://sourcepole.ch
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -122,54 +81,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: URL shortener
-test_files:
-- test/short_rails_test.rb
-- test/test_helper.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/application.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/routes.rb
-- test/dummy/README.rdoc
-- test/dummy/log/development.log
-- test/dummy/Rakefile
-- test/dummy/script/rails
-- test/dummy/config.ru
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/db/migrate/20130108094709_add_url_short_param_to_short_urls.short_rails.rb
-- test/dummy/db/migrate/20121123133344_create_short_rails_short_urls.short_rails.rb
-- test/dummy/db/schema.rb
-- test/dummy/db/development.sqlite3
-- test/dummy/public/422.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/500.html
-- test/dummy/public/404.html
-- test/integration/navigation_test.rb
+test_files: []