https://github.com/dpb587/shortlink-bundle

[WIP] A symfony2 bundle for creating a short link service (e.g. bit.ly, tiny.cc, t.co, goo.gl).
https://github.com/dpb587/shortlink-bundle

Last synced: 5 days ago
JSON representation

[WIP] A symfony2 bundle for creating a short link service (e.g. bit.ly, tiny.cc, t.co, goo.gl).

• Host: GitHub
• URL: https://github.com/dpb587/shortlink-bundle
• Owner: dpb587
• License: mit
• Created: 2013-03-19T20:32:25.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2013-04-06T23:46:42.000Z (over 11 years ago)
• Last Synced: 2024-10-30T18:13:26.534Z (about 2 months ago)
• Language: PHP
• Homepage:
• Size: 113 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
A symfony2 bundle for creating a short link service (e.g. bit.ly, tiny.cc, t.co, goo.gl).

Configuration

-------------

The following are the defaults (`./app/console config:dump dpb_shortcode`):

    Default configuration for extension with alias: "dpb_shortlink"

    dpb_shortlink:

    

        # Redirection URL when accessing / (or null to return a 404)

        root:                 ~

    

        # Options for generating short links

        link:

    

            # Character set to use for auto-generated short codes

            characters:           ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789

    

            # Length of auto-generated short codes

            default_length:       6

**Database** - currently only using Doctrine ORM (e.g. MySQL)...

    GRANT USAGE ON *.* TO app_shortlink@localhost IDENTIFIED BY 'test1234';

    GRANT ALL PRIVILEGES ON app_shortlink.* TO app_shortlink@localhost;

    CREATE DATABASE app_shortlink CHARSET = utf8 COLLATE = utf8_general_ci;

**Security Roles** - the following are used...

 * `ROLE_DPB_SHORTLINK_CREATE` - permission to create new links

**QR Codes** - separate library to install from [phpqrcode.sourceforge.net](http://phpqrcode.sourceforge.net/) (LGPL),

if necessary...

    mkdir Resources/vendor ; cd Resources/vendor/

    wget 'http://downloads.sourceforge.net/project/phpqrcode/releases/phpqrcode-2010100721_1.1.4.zip'

    unzip phpqrcode-2010100721_1.1.4.zip

    rm phpqrcode-2010100721_1.1.4.zip

Examples

--------

**Links**

 * `http://localhost/uKWRY9` - standard clickthru link

 * `http://localhost/uKWRY9/url.txt` - simple response of the destination URL

 * `http://localhost/uKWRY9/qrcode.png` - generate QR image - accepts `ec` (correction level; `l`, `m`, `q`, `h`) and `s` (size; 3)

**Security Configuration** (`app/config/security.yml`)

    providers:

        in_memory:

            memory:

                users:

                    myuser:

                        password: "mypass"

                        roles:

                            - "ROLE_DPB_SHORTLINK_CREATE"

    firewalls:

        api:

            pattern: "^/\+/"

            http_basic:

                realm: "API Endpoint"

**API**

    curl -si --user myuser:mypass -d url='http://www.example.com/hello-world.html' 'http://localhost/+/link/create-unique' | grep -iE '(location|http/)'

License

-------

[MIT License](./LICENSE)