go_links 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3efc845b1bbf2aaba529524c160c59aede4e702e
+  data.tar.gz: 2877a9088018b9f8dde05f6e406e9dbb0e06814e
+SHA512:
+  metadata.gz: 9897fdb550f98bc7354ebebcd9e78a122638bfec251c76a0b5e477de711aad621bd01bdd814431b0f0dafacb2c72c033fa1424ff37243dbfd8295e8816426801
+  data.tar.gz: f1a8cef8e24a6fb574b5e9ac4616e9647b83b7aa2346e82ae30cfbb276a2e946dfda52643bbf9bb15681ea0e56acfa011818d556431a3ad97af08aaac4407e8c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Ryan Kulp
+
+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,45 @@
+# GoLinks
+Dead simple link shortening and click tracking plugin for Cameleon CMS.
+
+Turns long URLs into branded, "/go/some-slug" destinations, which increases click-through engagements and is great for managing messy affiliate links.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'go_links'
+```
+
+Then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself:
+```bash
+$ gem install go_links
+```
+
+## Usage
+
+1. Install the gem
+2. `$ rake go_links:install` then `$ rake db:migrate`
+3. Activate plugin from your site's `/admin/plugins/` 'Disabled' tab
+4. Click 'settings' from Active tab to view and configure links
+
+## To do
+
+* Ability to Edit/Update a link destination
+* Ability to delete a link
+* Sorting by most/least in Index view
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GoLink'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_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/controllers/plugins/go_link/admin_controller.rb

@@ -0,0 +1,49 @@
+class Plugins::GoLink::AdminController < CamaleonCms::Apps::PluginsAdminController
+  include Plugins::GoLink::MainHelper
+  before_action :set_link, only: [:show]
+
+  def new
+    @go_link = Plugins::GoLink::GoLink.new
+  end
+
+  def show
+    if @link
+      @link.click!
+      redirect_to @link.destination
+    end
+  end
+
+  def create
+    @go_link = Plugins::GoLink::GoLink.new(go_link_params)
+
+    if @go_link.save
+      redirect_to url_for(action: :settings), notice: 'Link Saved Successfully'
+    else
+      # do something else
+    end
+  end
+
+  # show settings form
+  def settings
+    @go_links = Plugins::GoLink::GoLink.all
+  end
+
+  # save values from settings form
+  def save_settings
+    @plugin.set_options(params[:options]) if params[:options].present? # save option values
+    @plugin.set_metas(params[:metas]) if params[:metas].present? # save meta values
+    @plugin.set_field_values(params[:field_options]) if params[:field_options].present? # save custom field values
+    redirect_to url_for(action: :settings), notice: 'Settings Saved Successfully'
+  end
+  # add custom methods below ....
+
+  private
+
+    def set_link
+      @link = Plugins::GoLink::GoLink.find_by(slug: params[:slug])
+    end
+
+    def go_link_params
+      params.require(:go_link).permit(:slug, :destination)
+    end
+end

data/app/helpers/plugins/go_link/main_helper.rb

@@ -0,0 +1,29 @@
+module Plugins::GoLink::MainHelper
+  def self.included(klass)
+    # klass.helper_method [:my_helper_method] rescue "" # here your methods accessible from views
+  end
+
+  # here all actions on going to active
+  # you can run sql commands like this:
+  # results = ActiveRecord::Base.connection.execute(query);
+  # plugin: plugin model
+  def go_link_on_active(plugin)
+  end
+
+  # here all actions on going to inactive
+  # plugin: plugin model
+  def go_link_on_inactive(plugin)
+  end
+
+  # here all actions to upgrade for a new version
+  # plugin: plugin model
+  def go_link_on_upgrade(plugin)
+  end
+
+  # hook listener to add settings link below the title of current plugin (if it is installed)
+  # args: {plugin (Hash), links (Array)}
+  # permit to add unlimmited of links...
+  def go_link_on_plugin_options(args)
+    args[:links] << link_to('Settings', admin_plugins_go_link_settings_path)
+  end
+end

data/app/models/plugins/go_link/go_link.rb

@@ -0,0 +1,9 @@
+class Plugins::GoLink::GoLink < ActiveRecord::Base
+  # enable below for multi-site
+  # belongs_to :site, class_name: "CamleonCms::Site"
+
+  def click!
+    new_click_count = (self.clicks += 1)
+    self.update(clicks: new_click_count)
+  end
+end

data/app/views/plugins/go_links/admin/new.html.erb

@@ -0,0 +1,20 @@
+<div class="panel panel-default">
+    <div class="panel-heading">
+        <h4>Create an Outbound Link</h4>
+    </div>
+    <div class="panel-body">
+        <%= form_tag(url_for(action: :create), class: 'validate') do %>
+            <div class="form-group">
+                <label>Slug</label>
+                <%= text_field_tag 'go_link[slug]', @go_link.slug, class: 'form-control required' %>
+            </div>
+            <div class="form-group">
+                <label>Destination</label>
+                <%= text_field_tag 'go_link[destination]', @go_link.destination, class: 'form-control required' %>
+            </div>
+            <div class="form-group text-right">
+                <%= submit_tag 'Save Link', class: 'btn btn-primary' %>
+            </div>
+        <% end %>
+    </div>
+</div>

data/app/views/plugins/go_links/admin/settings.html.erb

@@ -0,0 +1,22 @@
+<div class="panel panel-default">
+    <div class="panel-heading">
+        <h4>Your Outbound Links</h4>
+        <%= link_to "add new", admin_plugins_go_link_new_path, class: 'pull-right btn btn-primary' %>
+    </div>
+    <table class="table">
+      <thead>
+        <th>Slug</th>
+        <th>Destination</th>
+        <th>Clicks</th>
+      </thead>
+      <tbody>
+        <% @go_links.each do |link| %>
+          <tr>
+            <td><%= link.slug %></td>
+            <td><%= link.destination %></td>
+            <td><%= link.clicks %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+</div>

data/config/camaleon_plugin.json

@@ -0,0 +1,14 @@
+{
+  "title": "Go Links",
+  "descr": "",
+  "key": "go_links", // must be the name of the folder of your plugin, sample: app/views/plugins/<my_plugin> ==> 'my_plugin'
+  "helpers": [
+    "Plugins::GoLinks::MainHelper"
+  ],
+  "hooks": {
+    "on_active": ["go_link_on_active"],
+    "on_inactive": ["go_link_on_inactive"],
+    "plugin_options": ["go_link_on_plugin_options"]
+    //here you can add all your hooks (read documentation)
+  }
+}

data/config/initializers/custom_models.rb

@@ -0,0 +1,5 @@
+#Rails.application.config.to_prepare do
+#   CamaleonCms::Site.class_eval do
+#     has_many :attack, class_name: "Plugins::Attack::Models::Attack"
+#   end
+# end

data/config/routes.rb

@@ -0,0 +1,21 @@
+Rails.application.routes.draw do
+    scope PluginRoutes.system_info["relative_url_root"] do
+
+      get 'go/:slug', to: 'plugins/go_link/admin#show'
+
+      #Admin Panel
+      scope :admin, as: 'admin', path: PluginRoutes.system_info['admin_path_name'] do
+        namespace 'plugins' do
+          namespace 'go_link' do
+            controller :admin do
+              get :new
+              post :create
+              get :index
+              post :save_settings
+            end
+          end
+        end
+      end
+
+    end
+  end

data/lib/go_links/railtie.rb

@@ -0,0 +1,9 @@
+class GoLink
+  class Railtie < Rails::Railtie
+
+    rake_tasks do
+      load "tasks/go_links.rake"
+    end
+
+  end
+end

data/lib/go_links/version.rb

@@ -0,0 +1,3 @@
+module GoLinks
+  VERSION = '0.1.0'
+end

data/lib/go_links.rb

@@ -0,0 +1,3 @@
+module GoLinks
+  require 'go_links/railtie' if defined?(Rails)
+end

data/lib/tasks/go_links.rake

@@ -0,0 +1,16 @@
+namespace :go_links do
+  desc "Creates table that stores slugs, destination urls, and click counts."
+  task :install => :environment do
+    puts "installing GoLinks..."
+
+    ActiveRecord::Schema.define do
+      create_table :plugins_go_links do |t|
+        t.string :slug
+        t.string :destination
+        t.integer :clicks, default: 0
+        t.timestamps null: false
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: go_links
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Kulp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-16 00:00:00.000000000 Z
+dependencies: []
+description: Create vanity URLs for outbound links.
+email:
+- ryanckulp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/go_link_manifest.js
+- app/controllers/plugins/go_link/admin_controller.rb
+- app/helpers/plugins/go_link/main_helper.rb
+- app/models/plugins/go_link/go_link.rb
+- app/views/plugins/go_links/admin/new.html.erb
+- app/views/plugins/go_links/admin/settings.html.erb
+- config/camaleon_plugin.json
+- config/initializers/custom_models.rb
+- config/routes.rb
+- lib/go_links.rb
+- lib/go_links/railtie.rb
+- lib/go_links/version.rb
+- lib/tasks/go_links.rake
+homepage: http://www.ryanckulp.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Cloak ugly links on your website with branded 'go' paths.
+test_files: []