RubyGems - corpshort - Versions diffs - 0.1.0 - Mend

corpshort 0.1.0

Files changed (30) hide show

checksums.yaml +7 -0
data/.gitignore +11 -0
data/.rspec +3 -0
data/.travis.yml +5 -0
data/Gemfile +8 -0
data/Gemfile.lock +83 -0
data/LICENSE.txt +21 -0
data/README.md +59 -0
data/Rakefile +6 -0
data/app/public/style.css +320 -0
data/app/views/edit.erb +26 -0
data/app/views/index.erb +24 -0
data/app/views/layout.erb +40 -0
data/app/views/list.erb +11 -0
data/app/views/show.erb +91 -0
data/bin/console +14 -0
data/bin/setup +8 -0
data/config.ru +40 -0
data/corpshort.gemspec +39 -0
data/lib/corpshort.rb +7 -0
data/lib/corpshort/app.rb +349 -0
data/lib/corpshort/backends/base.rb +34 -0
data/lib/corpshort/backends/dynamodb.rb +114 -0
data/lib/corpshort/backends/memory.rb +61 -0
data/lib/corpshort/backends/redis.rb +121 -0
data/lib/corpshort/horizontal_pdf.rb +105 -0
data/lib/corpshort/link.rb +83 -0
data/lib/corpshort/version.rb +3 -0
data/lib/corpshort/vertical_pdf.rb +107 -0
metadata +240 -0

@@ -0,0 +1,26 @@
+<section>
+  <h2>Edit: <%= @link.name %></h2>
+  <form action='<%= update_path(@link) %>' method='POST'>
+    <input type='hidden' name='_method' value='PUT'>
+    <div class='form-row'>
+      <label for='edit_new_name'>Name</label>
+      <input type='text' id='edit_new_name' name='new_name' placeholder='short-name' value="<%= @link.name %>">
+    </div>
+    <div class='form-row'>
+      <label for='edit_url'>URL</label>
+      <input type='text' id='edit_url' name='url' placeholder='https://...' value="<%= @link.url %>">
+    </div>
+    <input type='submit' value='Save'>
+  </form>
+  <p>Entering a new name will create an another link for the URL. To rename completely, manually delete the old link; Be careful with renaming existing links.</p>
+  <hr>
+  <form action='<%= update_path(@link) %>' method='POST'>
+    <input type='hidden' name='_method' value='DELETE'>
+    <p><input type='submit' onclick="return confirm('Are you sure?')" class='btn-danger' value='Delete'></p>
+  </form>
+</section>

data/app/views/index.erb ADDED

@@ -0,0 +1,24 @@
+<section class='new-link'>
+  <form action='/+/links' method='POST'>
+    <p><input type='text' name='url' placeholder='https://...' class='new-link-url'></p>
+    <p class='new-link-down'>⬇︎</p>
+    <p><input type='text' name='name' placeholder='Short name' class='new-link-name'></p>
+    <p><input type='submit' value='Shorten'></p>
+  </form>
+</section>
+<div class='infos'>
+  <% if notice_message %>
+    <section>
+      <h3>Notice</h3>
+      <%== notice_message %>
+    </section>
+  <% end %>
+  <section>
+    <h3>Usage</h3>
+    <form action='/+' method='GET'>
+      <p>Edit a link: <input type='text' name='show' placeholder='name...'> <input type='submit' value='Go'></p>
+    </form>
+    <p>Or add + (plus) sign after the URL like: <%= base_url %>/something → /something+</p>
+  </section>
+</div>

data/app/views/layout.erb ADDED

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset='utf-8'>
+    <meta name='viewport' content='width=device-width, minimum-scale=1'>
+    <title>Corpshort</title>
+    <link rel='stylesheet' href='/style.css' type="text/css">
+  </head>
+  <body>
+    <div class="container">
+      <header class="header">
+        <h1 class='logo'><a href="/">Corpshort</a></h1>
+        <nav>
+          <a href="/">Create</a>
+          <a href="/+/links">Recent</a>
+        </nav>
+      </header>
+      <% notice ||= session.delete(:notice); error ||= session.delete(:error) %>
+      <% if notice %>
+        <div class="notice"><%= notice %></div>
+      <% end %>
+      <% if error %>
+        <div class="error"><%= error %></div>
+      <% end %>
+      <div class="box">
+        <%== yield %>
+      </div>
+      <footer>
+        <div class="credit">
+          Powered by <a href="https://github.com/sorah/corpshort">sorah/corpshort</a>
+        </div>
+      </footer>
+    </div>
+  </body>
+</html>

data/app/views/list.erb ADDED

@@ -0,0 +1,11 @@
+<h1><%= @title %></h1>
+<ul>
+  <% @links.each do |name| %>
+    <li><a href='/<%= name %>+'><%= name %></li>
+  <% end %>
+</ul>
+<% if @next_token %>
+  <a href="<%= request.path %>?token=<%= URI.encode_www_form_component(@next_token) %>">More...</a>
+<% end %>

data/app/views/show.erb ADDED

@@ -0,0 +1,91 @@
+<section class='link'>
+  <header>
+    <h2><a href="<%= short_link_url(@link) %>"><%= short_base_url.gsub(%r{\A.+://}, '') %>/<%= @link.name %></a></h2>
+    <a href='#' class='btn-link copy_btn'><input class='copy_btn_input' tabindex='-1' value="<%= short_link_url(@link) %>"><span class='copy_btn_text'>Copy</span></a>
+    <a href="<%= edit_path(@link) %>" class='btn-link'>Edit</a>
+  </header>
+  <p><a class='link-url' href="<%= @link.url %>"><%= @link.url %></a></p>
+  <div class='infos'>
+    <section>
+      <h3>Embed</h3>
+      <p>PDF is recommended for Keynote</p>
+      <div class='barcode-style'>
+        <div class='barcode-style-diagram barcode-style-diagram-cu-horizontal'>
+          <div class='barcode-style-diagram-code'></div>
+          <div class='barcode-style-diagram-url'></div>
+        </div>
+        <div class='barcode-style-links'>
+          <h4>Code + URL (Horizontal)</h4>
+          <ul>
+            <li><a href="<%= barcode_path(@link, 'horizontal', 'pdf', flex: true) %>">PDF</a></li>
+            <li><a href="<%= barcode_path(@link, 'horizontal', 'pdf') %>">PDF (Short)</a></li>
+          </ul>
+        </div>
+      </div>
+      <div class='barcode-style'>
+        <div class='barcode-style-diagram barcode-style-diagram-cu-vertical'>
+          <div class='barcode-style-diagram-code'></div>
+          <div class='barcode-style-diagram-url'></div>
+        </div>
+        <div class='barcode-style-links'>
+          <h4>Code + URL (Vertical)</h4>
+          <ul>
+            <li><a href="<%= barcode_path(@link, 'vertical', 'pdf', flex: true) %>">PDF</a></li>
+            <li><a href="<%= barcode_path(@link, 'vertical', 'pdf') %>">PDF (Short)</a></li>
+          </ul>
+        </div>
+      </div>
+      <div class='barcode-style'>
+        <div class='barcode-style-diagram barcode-style-diagram-codeonly'>
+          <div class='barcode-style-diagram-code'></div>
+        </div>
+        <div class='barcode-style-links'>
+          <h4>Code Only</h4>
+          <small>Code + URL is recommended</small>
+          <ul>
+            <li><a href="<%= barcode_path(@link, 'small', 'pdf') %>">PDF</a></li>
+            <li><a href="<%= barcode_path(@link, 'small', 'svg') %>">SVG</a></li>
+            <li><a href="<%= barcode_path(@link, 'small', 'png') %>">PNG</a></li>
+          </ul>
+        </div>
+      </div>
+    </section>
+    <section>
+      <h3>Metadata</h3>
+      <ul>
+        <li>Updated at: <%= @link.updated_at.utc.iso8601 %></li>
+      </ul>
+    </section>
+    <section>
+      <h3>Actions</h3>
+      <nav>
+        <p><a href="<%= urls_path(@link.url) %>">List all links for this URL</a></p>
+      </nav>
+    </section>
+    <script type='text/javascript'>
+      "use strict";
+      document.addEventListener("DOMContentLoaded", function() {
+        const copySupported = document.queryCommandSupported("copy");
+        document.querySelectorAll(".copy_btn").forEach(function(elem) {
+          if (!copySupported) {
+            elem.className += ' hidden';
+            return;
+          }
+          elem.addEventListener("click", function(e) {
+            const value = e.currentTarget.querySelector(".copy_btn_input");
+            value.focus();
+            value.select();
+            document.execCommand("copy");
+            e.currentTarget.querySelector(".copy_btn_text").innerHTML = "Copied!";
+            e.preventDefault();
+          });
+          elem.addEventListener("mouseleave", function(e) {
+            e.currentTarget.querySelector(".copy_btn_text").innerHTML = "Copy";
+          });
+        });
+      });
+    </script>
+</section>

data/bin/console ADDED

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "corpshort"
+# 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 ADDED

@@ -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/config.ru ADDED

@@ -0,0 +1,40 @@
+require 'bundler/setup'
+require 'securerandom'
+require 'corpshort'
+if ENV['RACK_ENV'] == 'production'
+  raise 'Set $SECRET_KEY_BASE' unless ENV['SECRET_KEY_BASE']
+end
+config = {
+  base_url: ENV['CORPSHORT_BASE_URL'],
+  short_base_url: ENV['CORPSHORT_SHORT_BASE_URL'],
+}
+case ENV.fetch('CORPSHORT_BACKEND', 'redis')
+when 'redis'
+  require 'corpshort/backends/redis'
+  config[:backend] = Corpshort::Backends::Redis.new(
+    redis: ENV.key?('REDIS_URL') ? lambda { Redis.new(url: ENV['REDIS_URL']) } : Redis.method(:current),
+    prefix: ENV.fetch('CORPSHORT_REDIS_PREFIX', 'corpshort:'),
+  )
+when 'dynamodb'
+  require 'corpshort/backends/dynamodb'
+  config[:backend] = Corpshort::Backends::Dynamodb.new(
+    region: ENV.fetch('CORPSHORT_DYNAMODB_REGION'),
+    table: ENV.fetch('CORPSHORT_DYNAMODB_TABLE'),
+  )
+else
+  raise ArgumentError, "Unsupported $CORPSHORT_BACKEND"
+end
+use(
+  Rack::Session::Cookie,
+  key: 'corpshortsess',
+  expire_after: 86400,
+  secure: ENV.fetch('CORPSHORT_SECURE_SESSION', ENV['RACK_ENV'] == 'production' ? '1' : nil) == '1',
+  secret: ENV.fetch('SECRET_KEY_BASE', SecureRandom.base64(256)),
+)
+run Corpshort.app(config)

data/corpshort.gemspec ADDED

@@ -0,0 +1,39 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "corpshort/version"
+Gem::Specification.new do |spec|
+  spec.name          = "corpshort"
+  spec.version       = Corpshort::VERSION
+  spec.authors       = ["Sorah Fukumori"]
+  spec.email         = ["sorah@cookpad.com"]
+  spec.summary       = %q{"go/" like private link shortener for internal purpose}
+  spec.homepage      = "https://github.com/sorah/corpshort"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "sinatra"
+  spec.add_dependency "rack-protection"
+  spec.add_dependency "erubi"
+  spec.add_dependency "redis"
+  spec.add_dependency "aws-sdk-dynamodb"
+  spec.add_dependency "rqrcode"
+  spec.add_dependency "prawn"
+  spec.add_dependency "prawn-qrcode"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rack-test"
+end

data/lib/corpshort.rb ADDED

@@ -0,0 +1,7 @@
+require "corpshort/version"
+require "corpshort/link"
+require "corpshort/app"
+module Corpshort
+  # Your code goes here...
+end

data/lib/corpshort/app.rb ADDED

@@ -0,0 +1,349 @@
+require 'rqrcode'
+require 'prawn'
+require 'prawn/qrcode'
+require 'json'
+require 'erubi'
+require 'sinatra/base'
+require 'rack/protection'
+require 'corpshort/link'
+require 'corpshort/vertical_pdf'
+require 'corpshort/horizontal_pdf'
+require 'uri'
+module Corpshort
+  def self.app(*args)
+    App.rack(*args)
+  end
+  class App < Sinatra::Base
+    CONTEXT_RACK_ENV_NAME = 'corpshort.ctx'
+    def self.initialize_context(config)
+      {
+        config: config,
+      }
+    end
+    def self.rack(config={})
+      klass = App
+      test = config[:test]
+      session = {}
+      context = initialize_context(config)
+      lambda { |env|
+        env['rack.session'] = session if test # FIXME:
+        env[CONTEXT_RACK_ENV_NAME] = context
+        klass.call(env)
+      }
+    end
+    configure do
+      enable :logging
+    end
+    set :root, File.expand_path(File.join(__dir__, '..', '..', 'app'))
+    set :erb, :escape_html => true
+    use Rack::Protection::FrameOptions
+    use Rack::Protection::HttpOrigin
+    use Rack::Protection::IPSpoofing
+    use Rack::Protection::JsonCsrf
+    use Rack::Protection::PathTraversal
+    use Rack::Protection::RemoteToken, only_if: -> (env) { ! env['PATH_INFO'].start_with?('/+api') }
+    use Rack::Protection::SessionHijacking
+    use Rack::Protection::XSSHeader
+    use Rack::MethodOverride
+    helpers do
+      include Prawn::Measurements
+      def context
+        request.env[CONTEXT_RACK_ENV_NAME]
+      end
+      def conf
+        context.fetch(:config)
+      end
+      def notice_message
+        conf[:notice_message]
+      end
+      def base_url
+        conf[:base_url] || request.base_url
+      end
+      def short_base_url
+        conf[:short_base_url] || base_url
+      end
+      def backend
+        @backend ||= conf.fetch(:backend)
+      end
+      def link_name(name = params[:name])
+        name.tr('_', '-')
+      end
+      def short_link_url(link, **kwargs)
+        link_url(link, base_url: short_base_url, **kwargs)
+      end
+      def link_url(link, protocol: true, base_url: self.base_url())
+        name = link.is_a?(String) ? link_name(link) : link.name
+        "#{base_url}/#{name}".yield_self do |url|
+          if protocol
+            url
+          else
+            url.gsub(/\Ahttps?:\/\//, '')
+          end
+        end
+      end
+      def edit_path(link)
+        "/+/links/#{URI.encode_www_form_component(link.name)}/edit"
+      end
+      def update_path(link)
+        "/+/links/#{URI.encode_www_form_component(link.name)}"
+      end
+      def urls_path(url)
+        "/+/urls/#{url}"
+      end
+      def barcode_path(link, kind, ext, flex: nil)
+        "/+/links/#{URI.encode_www_form_component(link.name)}/#{kind}.#{ext}#{flex.nil? ? nil : "?flex=#{flex}"}"
+      end
+    end
+    get '/' do
+      erb :index
+    end
+    ## Pages
+    get '/+' do
+      if params[:show]
+        redirect "/+/links/#{link_name(params[:show])}"
+      end
+      halt 404
+    end
+    post '/+/links' do
+      unless params[:name] && params[:url]
+        session[:error] = "Name and URL are required"
+        redirect '/'
+      end
+      begin
+        link = Link.new({name: link_name, url: params[:url]})
+        link.save!(backend, create_only: true)
+      rescue Corpshort::Link::ValidationError, Corpshort::Backends::Base::ConflictError
+        session[:error] = $!.message
+        redirect '/'
+      end
+      redirect "/#{link.name}+"
+    end
+    get '/+/links' do
+      @links, @next_token = backend.list_links(token: params[:token])
+      @title = "Recent links"
+      erb :list
+    end
+    get '/+/links/*name/small.svg' do
+      @link = backend.get_link(params[:name])
+      halt 404, "not found" unless @link
+      content_type :svg
+      RQRCode::QRCode.new(link_url(@link), level: :m).as_svg(module_size: 6)
+    end
+    get '/+/links/*name/small.png' do
+      @link = backend.get_link(params[:name])
+      halt 404, "not found" unless @link
+      content_type :png
+      RQRCode::QRCode.new(link_url(@link), level: :m).as_png(size: 120).to_datastream.to_s
+    end
+    get '/+/links/*name/small.pdf' do
+      @link = backend.get_link(params[:name])
+      halt 404, "not found" unless @link
+      content_type :pdf
+      Prawn::Document.new(page_size: [cm2pt(2), cm2pt(2)], margin: 0) do |pdf|
+        pdf.fill_color 'FFFFFF'
+        pdf.fill { pdf.rounded_rectangle [cm2pt(2), cm2pt(2)], cm2pt(2), cm2pt(2), 10 }
+        pdf.print_qr_code(link_url(@link), level: :m, extent: cm2pt(2), stroke: false)
+      end.render
+    end
+    get '/+/links/*name/vertical.pdf' do
+      @link = backend.get_link(params[:name])
+      halt 404, "not found" unless @link
+      content_type :pdf
+      VerticalPdf.new(
+        url: link_url(@link),
+        base_url: short_base_url.sub(%r{\A.+://}, ''),
+        name: @link.name,
+        flex: params[:flex],
+      ).document.render
+    end
+    get '/+/links/*name/horizontal.pdf' do
+      @link = backend.get_link(params[:name])
+      halt 404, "not found" unless @link
+      content_type :pdf
+      HorizontalPdf.new(
+        url: link_url(@link),
+        base_url: short_base_url.sub(%r{\A.+://}, ''),
+        name: @link.name,
+        flex: params[:flex],
+      ).document.render
+    end
+    get '/+/links/*name/edit' do
+      @link = backend.get_link(params[:name])
+      if @link
+        erb :edit
+      else
+        halt 404, "not found"
+      end
+    end
+    get '/+/links/*name' do
+      redirect "/#{params[:name]}+"
+    end
+    put '/+/links/*name' do
+      @link = backend.get_link(params[:name])
+      halt 404, "not found" unless @link
+      @link.url = params[:url] if params[:url]
+      rename = params[:new_name] && @link.name != params[:new_name]
+      if rename
+        new_name = link_name(params[:new_name])
+        @link = Link.new(name: new_name, url: @link.url)
+        # Link.validate_name(new_name)
+        # backend.rename_link(@link, new_name)
+      end
+      begin
+        @link.save!(backend, create_only: rename)
+      rescue Corpshort::Link::ValidationError, Corpshort::Backends::Base::ConflictError
+        session[:error] = $!.message
+        redirect "/+/links/#{@link.name}/edit"
+      end
+      redirect "/#{@link.name}+"
+    end
+    delete '/+/links/*name' do
+      backend.delete_link(params[:name])
+      redirect "/"
+    end
+    get '/+/urls/*url' do
+      url = env['REQUEST_URI'][8..-1]
+      @links, @next_token = backend.list_links_by_url(url), nil
+      @title = "Links for URL #{url}"
+      erb :list
+    end
+    ## API
+    get '/+api/links' do
+      content_type :json
+      links, next_token = backend.list_links(token: params[:token])
+      {links: links, next_token: next_token}.to_json
+    end
+    post '/+api/links' do
+      content_type :json
+      unless params[:name] && params[:url]
+        halt 400, '{"error": "missing_params", "error_message": "name and url are required"}'
+      end
+      begin
+        link = Link.new({name: link_name, url: params[:url]})
+        link.save!(backend, create_only: true)
+      rescue Corpshort::Link::ValidationError => e
+        halt(400, {error: :validation_error, error_message: e.message}.to_json)
+      rescue Corpshort::Backends::Base::ConflictError
+        halt(409, {error: :conflict, error_message: e.message}.to_json)
+      end
+      link.to_json
+    end
+    get '/+api/links/*name' do
+      content_type :json
+      link = backend.get_link(link_name)
+      halt 404, '{"error": "not_found"}' unless link
+      link.to_json
+    end
+    put '/+api/links/*name' do
+      content_type :json
+      link = backend.get_link(link_name)
+      halt 404, '{"error": "not_found"}' unless link
+      link.url = params[:url] if params[:url]
+      begin
+        link.save!(backend)
+      rescue Corpshort::Link::ValidationError => e
+        halt(400, {error: :validation_error, error_message: e.message}.to_json)
+      rescue Corpshort::Backends::Base::ConflictError
+        halt(409, {error: :conflict, error_message: e.message}.to_json)
+      end
+      link.to_json
+    end
+    delete '/+api/links/*name' do
+      backend.delete_link(link_name)
+      status 202
+      ""
+    end
+    get '/+api/urls/*url' do
+      content_type :json
+      url = env['REQUEST_URI'][8..-1]
+      links, next_token = backend.list_links_by_url(url), nil
+      {links: links, next_token: next_token}.to_json
+    end
+    ## Shortlink
+    get '/*name' do
+      name = params[:name]
+      show = name.end_with?('+')
+      if show
+        name = name[0..-2]
+      end
+      @link = backend.get_link(link_name(name))
+      unless @link
+        halt 404, 'not found'
+      end
+      if show
+        erb :show
+      else
+        redirect @link.url
+      end
+    end
+  end
+end