darjeelink 0.11.10 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bb8e036f92bfb2145607b781537440e1dab86664c300e8313881e4d73f07940
-  data.tar.gz: 7b8653822b7c206acc6ce03b4d0ccfad2d7ae7732b08ee597c458440ec4ba255
+  metadata.gz: 554db4290be45099082761d6ddac6c744af2f29e05bdca693612ce845e99c08b
+  data.tar.gz: 643e1a58e853742d681eadcac76eaa067d4f1de77fa30d01f38a4a30446c6f5d
 SHA512:
-  metadata.gz: 8c64837b6368ac6f72fab25cd3f17bc0f794e74a4bd60cfe9f323dc2785624a82fc107472702ca8b6898e423c64d9ede7f3c7e5ef2a667faf07fe5ae3494b12d
-  data.tar.gz: 541fa60fc561f4de4e476673884d9571bc8ccffaecee9b8b73b7696495ec50881da0b2807c5e0b07a32507020b62273c2141b4a84168cf0a75ff30071051f1f8
+  metadata.gz: dca0c51ec2669ce28986041e07893154f2639b2a57e50b147237a488f606d72ad22e8d06b6349d4a040f212b3a827f6e295eb44a63ccb67a1de833556a14ff98
+  data.tar.gz: 0714d875f7c7a037ea538715df0e65710d145d8600943bfcd9cf0ed24dac1ad39acccf414e13e26c9ef180d9212a9762d13e37cf5a0fb0296d12a68ae8857da9

data/README.md

@@ -19,6 +19,48 @@ There is a UTM generator, where you can provide:
 - a campaign identifier
 And you can get a link with UTM params all filled in, and shortern it with one click.
 
+## API
+There is an API available to create short links.
+To create a short link via the API:
+
+First, create an api token `Darjeelink::ApiToken.create!(username: <username>, active: true)`.
+Then grab the token.
+
+Next, make a request
+```
+POST /api
+Authorization => Token token=<username>:<token>
+{
+  short_link: {
+    url: 'https://www.example.com',
+    shortened_path: 'xmpl' (optional)
+  }
+}
+```
+`url` is the absolute URI that you wish to shorten
+`shortened_path` is the path that you will visit to get redirected to your original link.  It is optional.  If it is not provided one will be generated automatically
+
+If successful you will get a response like:
+```
+STATUS 201
+{
+  short_link: <shortened_url>
+}
+```
+
+If unsuccessful you will get a response like
+```
+STATUS 400
+{
+  error: "information on what went wrong"
+}
+```
+
+If authorization failed you will get a response like
+```
+STATUS 401
+{}
+```
 ## Installation
 ### Gemfile
 Add these lines to your app's Gemfile

data/app/controllers/darjeelink/api_controller.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Darjeelink
+  class ApiController < Darjeelink::ApplicationController
+    skip_before_action :check_ip_whitelist
+    skip_before_action :authenticate
+
+    before_action :authenticate_token
+
+    def create
+      short_link = Darjeelink::ShortLink.create!(short_link_params)
+
+      render(
+        json: { short_link: "#{Darjeelink.domain}/#{short_link.shortened_path}" },
+        status: :created
+      )
+    rescue ActiveRecord::RecordNotUnique
+      render(
+        json: { error: "#{short_link_params[:shortened_path]} already used! Choose a different custom path" },
+        status: :bad_request
+      )
+    rescue ActiveRecord::RecordInvalid => e
+      render(
+        json: { error: e.message.to_s },
+        status: :bad_request
+      )
+    rescue ActionController::ParameterMissing
+      render(
+        json: { error: 'Missing required params' },
+        status: :bad_request
+      )
+    end
+
+    private
+
+    def short_link_params
+      params.require(:short_link).permit(:url, :shortened_path)
+    end
+
+    def authenticate_token
+      # The Authorization header must be supplied in the following format:
+      # "Authorization" => "Token token=#{username}:#{token}"
+      authenticate_or_request_with_http_token do |username_token, _options|
+        # Perform token comparison; avoid timing attacks and length leaks
+        # See: https://thisdata.com/blog/timing-attacks-against-string-comparison/
+        return head(:unauthorized) unless valid_authorization_token?(username_token)
+
+        return true
+      end
+    end
+
+    def valid_authorization_token?(username_token)
+      username, token = username_token.split ':'
+
+      stored_token = ApiToken.find_by(username: username, active: true)&.token
+      return false if stored_token.nil?
+
+      ActiveSupport::SecurityUtils.secure_compare(
+        token,
+        stored_token
+      )
+    end
+  end
+end

data/app/models/darjeelink/api_token.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Darjeelink
+  class ApiToken < ApplicationRecord
+    validates :username, uniqueness: true
+    validates :token, length: { minimum: 32 }, uniqueness: true
+
+    before_validation :generate_token
+
+    def generate_token
+      self.token = SecureRandom.uuid if token.blank?
+    end
+  end
+end

data/config/initializers/darjeelink.rb

@@ -14,6 +14,8 @@ Darjeelink.configure do |config|
     'sms-blast': 'SMS Blast',
     'google-advert': 'Google advert',
     'instagram-advert': 'Instagram Advert',
+    'instagram-post': 'Instagram Post',
+    'instagram-story': 'Instagram Story',
     chatbot: 'Chatbot',
     template: 'Template',
     other: 'Other',

data/config/routes.rb

@@ -5,6 +5,7 @@ Darjeelink::Engine.routes.draw do
 
   resources :short_links
   resources :tracking_links, only: :new
+  resources :api, only: :create
 
   # OmniAuth
   get '/auth/:provider/callback', to: 'sessions#create'

data/db/migrate/20210610083330_create_darjeelink_api_tokens.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateDarjeelinkApiTokens < ActiveRecord::Migration[6.1]
+  def change
+    create_table :darjeelink_api_tokens do |t|
+      t.string :token, null: false
+      t.string :username, null: false
+      t.boolean :active, null: false, default: false
+      t.timestamps
+    end
+
+    add_index(:darjeelink_api_tokens, :username, unique: true)
+    add_index(:darjeelink_api_tokens, :token, unique: true)
+  end
+end

data/lib/darjeelink/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Darjeelink
-  VERSION = '0.11.10'
+  VERSION = '0.13.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darjeelink
 version: !ruby/object:Gem::Version
-  version: 0.11.10
+  version: 0.13.1
 platform: ruby
 authors:
 - James Hulme
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2022-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: rebrandly
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +207,7 @@ files:
 - app/assets/javascripts/darjeelink/sparkleh.js
 - app/assets/javascripts/darjeelink/tracking_link_generator.js
 - app/assets/stylesheets/darjeelink/application.css
+- app/controllers/darjeelink/api_controller.rb
 - app/controllers/darjeelink/application_controller.rb
 - app/controllers/darjeelink/sessions_controller.rb
 - app/controllers/darjeelink/short_links_controller.rb
@@ -216,6 +217,7 @@ files:
 - app/importers/darjeelink/short_link_importer.rb
 - app/jobs/darjeelink/application_job.rb
 - app/mailers/darjeelink/application_mailer.rb
+- app/models/darjeelink/api_token.rb
 - app/models/darjeelink/application_record.rb
 - app/models/darjeelink/short_link.rb
 - app/views/darjeelink/short_links/_short_link_form.erb
@@ -233,6 +235,7 @@ files:
 - db/migrate/20190304094710_case_insensitive_index_short_link_shortened_path.rb
 - db/migrate/20200505220716_rename_portkey_short_links_to_darjeelink_short_links.rb
 - db/migrate/20200505221026_rename_portkey_short_link_index.rb
+- db/migrate/20210610083330_create_darjeelink_api_tokens.rb
 - lib/darjeelink.rb
 - lib/darjeelink/configuration.rb
 - lib/darjeelink/engine.rb
@@ -250,14 +253,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: URL Shortener