short_rails 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzQ4MTQwZmY4MTI1NDA2MDBlMjA4NmRjMjJiNzJjZjM4OTdmZGE1ZQ==
+  data.tar.gz: !binary |-
+    YTNlNzhjMDhjNmFmYWExMGJmN2MxNmU2YWZjZmQzOGUwMDM2OGFjYw==
+SHA512:
+  metadata.gz: !binary |-
+    YjJhMTA3YTQ4NWQ1NGE0MTY5YzIyZTQ2ZWNmMWZlOGU4YTA4NGI5MmJhZDhh
+    N2M5OGM3NDcyNjBjYTdmNGQwZmZkNmFkNWU0OGQyODI2MzgzMGYyMGQxYjVl
+    MzBmMjRlZDUxNjdhMWJlMDQzYTAyMjY5ZWQyMmVjNDljMGIzYTY=
+  data.tar.gz: !binary |-
+    M2Q5OGRlYjZmY2QxZmFmODcyMjE2NzE4MjMwOTk0MWI4Y2MwZGVhYTgwMDkx
+    NmUxZGJjYTBkZTY3Y2FkMDI5ZDNhZjgzMjlhNWRjNjU3MmY1ZDNmYWM2OTkz
+    M2QxMTI4MmEzMjFjMjY3NjkwZDJmZWNjMmJiOTliMjQ1YzIzMjY=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Sourcepole
+
+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,65 @@
+# ShortRails
+
+URL shortener for Rails.
+
+## Installation:
+
+Add this line to your application's Gemfile:
+
+    gem 'short_rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install short_rails
+
+## Configuration
+
+Mount engine in config/routes.rb
+
+    Rails.application.routes.draw do
+      mount ShortRails::Engine => "/s"
+    end
+
+Copy engine migrations to application
+
+    $ rake short_rails:install:migrations
+    $ rake db:migrate
+
+Run standalone dummy app
+
+    $ cd test/dummy/
+    $ rails s
+
+    http://localhost:3000/s
+
+## Usage
+
+* 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
+
+    returns short id (e.g. 'abc123')
+
+* GET /s/abc123
+    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")
+
+    else redirect to full URL
+
+* GET /s/abc123/params
+    get full URL parameters as JSON
+
+* 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
+
+    get QR code as PNG image

data/Rakefile

@@ -0,0 +1,40 @@
+#!/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'
+
+
+
+Bundler::GemHelper.install_tasks
+
+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

data/app/assets/javascripts/short_rails/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

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

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * 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.
+ *
+ * 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.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/short_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module ShortRails
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/short_rails/short_urls_controller.rb

@@ -0,0 +1,107 @@
+require_dependency "short_rails/application_controller"
+
+module ShortRails
+  class ShortUrlsController < ApplicationController
+
+    # GET ':id'
+    # redirect to base URL
+    def show
+      short_url = ShortUrl.find_by_short(params[:short])
+
+      if short_url.url_short_param.nil?
+        # redirect to full URL
+        query_params = short_url.params
+      else
+        # redirect to base URL with short param
+        query_params = {short_url.url_short_param => short_url.short}
+      end
+
+      redirect_to "#{short_url.url}?#{query_params.to_query}"
+    end
+
+    # POST '/'
+    # create short URL
+    def create
+      begin
+        short = SecureRandom.base64(6).tr("+/=", "xyz").downcase
+      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)
+      if short_url.save
+        # return short id
+        render :text => short
+      else
+        head :no_content
+      end
+    end
+
+    # GET ':id/params'
+    # get parameters for full URL
+    def parameters
+      short_url = ShortUrl.find_by_short(params[:short])
+
+      render :text => short_url.params.to_json
+    end
+
+    # GET ':id/qrcode'
+    # get QR code containing this short URL
+    def qrcode
+      require 'rqrcode_png'
+
+      if ShortUrl.find_by_short(params[:short]).nil?
+        render :text => "ERROR: Could not generate QR code", :status => :bad_request
+        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
+        return
+      end
+
+      # create QR code with minimal version
+      qr = nil
+      version = 3
+      while qr.nil? && version < 40
+        begin
+          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
+        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
+
+      if width > img_size || height > img_size
+        # calculate image size to fit scaled QR code to requested size
+        size = [width, height].min
+        img_size = (size / img_size) * img_size
+        qr_image = qr_image.resize(img_size, img_size)
+
+        if width > img_size || height > img_size
+          # center QR code in image of requested size
+          image = ::ChunkyPNG::Image.new(width, height, ::ChunkyPNG::Color::WHITE)
+          offset_x = (width - img_size) / 2
+          offset_y = (height - img_size) / 2
+          qr_image = image.replace(qr_image, offset_x, offset_y)
+        end
+      end
+
+      send_data qr_image.to_string, :type => 'image/png', :disposition => 'inline', :filename => "#{params[:short]}.png"
+    end
+
+  end
+end

data/app/helpers/short_rails/application_helper.rb

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

data/app/models/short_rails/short_url.rb

@@ -0,0 +1,7 @@
+module ShortRails
+  class ShortUrl < ActiveRecord::Base
+    attr_accessible :short, :url, :url_short_param, :params
+
+    serialize :params
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ShortRails</title>
+  <%= stylesheet_link_tag    "short_rails/application", :media => "all" %>
+  <%= javascript_include_tag "short_rails/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +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
+
+  root :to => 'short_urls#create', :via => :post
+end

data/db/migrate/20121123124825_create_short_rails_short_urls.rb

@@ -0,0 +1,11 @@
+class CreateShortRailsShortUrls < ActiveRecord::Migration
+  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.timestamps
+    end
+  end
+end

data/db/migrate/20130108094545_add_url_short_param_to_short_urls.rb

@@ -0,0 +1,5 @@
+class AddUrlShortParamToShortUrls < ActiveRecord::Migration
+  def change
+    add_column :short_rails_short_urls, :url_short_param, :string
+  end
+end

data/lib/short_rails.rb

@@ -0,0 +1,4 @@
+require "short_rails/engine"
+
+module ShortRails
+end

data/lib/short_rails/engine.rb

@@ -0,0 +1,5 @@
+module ShortRails
+  class Engine < ::Rails::Engine
+    isolate_namespace ShortRails
+  end
+end

data/lib/short_rails/version.rb

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

data/lib/tasks/short_rails_tasks.rake

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

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.