trustlink 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59d10950b9e1a40d94a68ec59235e2aea1a98c0f
-  data.tar.gz: 77eb4ad1b69de9d15a12959c784eb4ae5eca7a1d
+  metadata.gz: e157417462bdd92d4e49bb88cdb5bd08eeb239db
+  data.tar.gz: 7dcfbab178cd6877a26a0e7afa9b08c4ada22dab
 SHA512:
-  metadata.gz: 6eb62809e0fbaed51cb091901b099f426c566a41a4cb003a1db7478cf90d1a4164b73b1f3e1b19fe33efca1b0d6ef4153c5d373829a0f6e7d5e674c76af95ecf
-  data.tar.gz: 6f32b108ade8d831306072c760cffb8355da9024450d8ccd4bfb8152e79a52b47e37ba0ac3157061de300cd6d15c61640f637a4e6ad199756f1d8aceae1cb108
+  metadata.gz: 72f5c1e2d6a31015da79feff594588e66a322cf22605d5c89290e964511c7e87b82e9bae254383dd1790315e407dae303584a84e01442a1ec5d7b4fd432b299d
+  data.tar.gz: 43177aab53f6a65f59048880db6df9a2397fd0a9580bdf5f0228fc7b28bb7b1895990e37dc9c911656643050ded255ad8dd8be10fb420c43020f297cfdd18f1e

data/README.md

@@ -0,0 +1,47 @@
+##Trustlink module for Ruby On Rails
+
+###Rewritten from scratch
+
+### Changes
+* parsing xml file instead of php serialized string
+* storing in database instead of text file
+* requesting by rake task instead of checking on every page load
+* customizable rails friendly erb templates
+
+### Installation
+Include the gem in your Gemfile:
+```ruby
+gem "trustlink"
+```
+
+#### preparing db
+* `rails g trustlink:migration`
+* `rake db:migrate`
+
+#### generating config
+* create config/trustlink.yml
+```yml
+key: _YOUR_TRUSTLINK_HASH_
+domain: example.com
+encoding: UTF-8
+```
+
+#### customizing templates (optional)
+* `rails g trustlink:views`
+Templates will be copied to views/trustlink folder.
+
+#### fetching links
+* `rake trustlink:fetch`
+Run it by cron or use whenever gem or something other way you like.
+
+### Notes
+* In _link.html.erb first and last string inserting trustlink code recognized by trustlink bots. It should not be removed. Also important to levae url untouched.
+* By default no style included. You can use styles extracted from trustlink's template. Just replace class to 'ads' used by default or use your own.
+* Multi-domain feature currently not supported. Ask if you need.
+
+For more information please follow http://www.trustlink.ru/
+
+License
+-------
+This project rocks and uses MIT-LICENSE.
+Copyright © 2014 Artyom Nikolaev and Trustlink

data/Rakefile

@@ -19,14 +19,9 @@ end
 
 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
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new('spec')
 
-task default: :test
+# If you want to make this the default task
+task default: :spec

data/lib/app/helpers/trustlink_helper.rb

@@ -0,0 +1,14 @@
+require 'domainatrix'
+
+module TrustlinkHelper
+  def trustlink_links
+    options = { links: TrustlinkLink.where(page: request.path) }
+    if TrustlinkConfig.bot_ips.include?(request.remote_addr)
+      options.merge!(start: TrustlinkConfig.start_code)
+      options.merge!(stop:  TrustlinkConfig.stop_code)
+    end
+    render template: 'trustlink/links', locals: options
+  rescue Exception => e
+    "<!-- ERROR: #{e.message} -->".html_safe
+  end
+end

data/lib/app/models/trustlink_config.rb

@@ -0,0 +1,15 @@
+class TrustlinkConfig < ActiveRecord::Base
+  class << self
+    def bot_ips
+      where(name: 'ip').pluck(:value)
+    end
+
+    def start_code
+      where(name: 'start').first.value
+    end
+
+    def stop_code
+      where(name: 'stop').first.value
+    end
+  end
+end

data/lib/app/models/trustlink_link.rb

@@ -0,0 +1,6 @@
+class TrustlinkLink < ActiveRecord::Base
+  def host
+    link = Domainatrix.parse(url)
+    link.host
+  end
+end

data/lib/app/views/trustlink/_link.html.erb

@@ -0,0 +1,5 @@
+<li>
+  <div class="link"><%= link_to link.anchor, link.url -%></div>
+  <div class="text"><%= link.text -%></div>
+  <div class="host"><%= link.host -%></div>
+</li>

data/lib/app/views/trustlink/links.html.erb

@@ -0,0 +1,7 @@
+<%= start.html_safe if defined?(start) -%>
+<% if links.any? -%>
+  <ul class="ads">
+    <%= render partial: 'trustlink/link', collection: links -%>
+  </ul>
+<% end -%>
+<%= stop.html_safe if defined?(start) -%>

data/lib/generators/trustlink/migration_generator.rb

@@ -0,0 +1,19 @@
+class Trustlink::MigrationGenerator < Rails::Generators::Base
+  require 'rails/generators'
+  require 'rails/generators/migration'
+
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
+    else
+      sprintf('%.3d', (current_migration_number(dirname) + 1))
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_trustlink_storage.rb'
+  end
+end

data/lib/generators/trustlink/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateTrustlinkStorage < ActiveRecord::Migration
+  def change
+    create_table :trustlink_configs do |t|
+      t.string :name
+      t.string :value
+    end
+
+    create_table :trustlink_links do |t|
+      t.string :page
+      t.string :anchor
+      t.string :text
+      t.string :url
+    end
+  end
+end

data/lib/generators/trustlink/views_generator.rb

@@ -0,0 +1,10 @@
+class Trustlink::ViewsGenerator < Rails::Generators::Base
+  require 'rails/generators/base'
+
+  public_task :copy_views
+  source_root File.expand_path('../../../app/views', __FILE__)
+
+  def copy_views
+    directory 'trustlink', 'app/views/trustlink'
+  end
+end

data/lib/tasks/trustlink.rake

@@ -0,0 +1,66 @@
+require 'nokogiri'
+require 'open-uri'
+
+namespace :trustlink do
+  def say text
+    if Rails.env.development?
+      puts text
+    end
+  end
+
+  desc "Fetch links from server"
+  task fetch: :environment do
+    begin
+      config = YAML.load_file('config/trustlink.yml') 
+    rescue Errno::ENOENT
+      fail "Config file not found (config/trustlink.yml)"
+    end
+    
+    key      = config['key']
+    domain   = config['domain'].downcase
+    encoding = config['encoding'].upcase || 'UTF-8'
+    server   = config['server']          || 'db.trustlink.ru'
+    
+    url = "http://#{server}/#{key}/#{domain}/#{encoding}.xml"
+    begin
+      data = open(url)
+    rescue OpenURI::HTTPError
+      fail "Could not receive data"
+    end
+
+    root = Nokogiri::XML(data.read).root
+
+    bot_ips = root.xpath('bot_ips/ip')
+    configs = root.xpath('config/item')
+    pages   = root.xpath('pages/page')
+
+    if pages.any?
+      TrustlinkConfig.delete_all
+      TrustlinkLink.delete_all
+
+      say "Ips:"
+      bot_ips.each do |ip|
+        TrustlinkConfig.create name: 'ip', value: ip.text
+        say "Added #{ip.text}"
+      end
+
+      say "Config"
+      configs.each do |item|
+        TrustlinkConfig.create name: item['name'], value: item.text
+        say "Added #{item['name']} = #{item.text}"
+      end
+
+      say "Links"
+      pages.each do |page|
+        say "Page: #{page['url']}"
+        page.xpath('link').each do |item|
+          anchor = item.at_xpath('anchor').text
+          text   = item.at_xpath('text').text
+          url    = item.at_xpath('url').text
+          TrustlinkLink.create page: page['url'], anchor: anchor, text: text, url: url
+          say "   Added #{anchor} #{text} #{url}"
+        end
+      end
+    end
+  end
+end

data/lib/trustlink/railtie.rb

@@ -0,0 +1,6 @@
+class Trustlink::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'tasks/trustlink.rake'
+  end
+end
+  

data/lib/trustlink/version.rb

@@ -1,3 +1,3 @@
 module Trustlink
-  VERSION = "0.0.3"
+  VERSION = '0.0.4'
 end

data/lib/trustlink.rb

@@ -1,295 +1,12 @@
-require 'fileutils'
-require 'net/http'
-require 'php_serialize'
-
 module Trustlink
-  class TlClient
-
-    VERSION                = 'T0.0.1'
-    DEBUG                  = false
-    TEST_COUNT             = 4
-    TEMPLATE               = 'template'
-    USE_SSL                = false
-    SERVER                 = 'db.trustlink.ru'
-    CACHE_LIFETIME         = 3600
-    CACHE_RELOADTIME       = 300
-
-    class << self; attr_accessor :app_folder, :data_folder, :data, :charset, :host, :force_show_code, :multi_site, :is_static, :tl_user, :verbose, :test end
-
-    attr_accessor :links, :links_page, :request_uri, :request, :error, :file_change_date, :file_size, :links_delimiter, :links_count, :isrobot, :skip_load_links
-
-    def initialize user, request, options = {}
-      @app_folder        = Rails.root
-      @data_folder       = 'public'
-      @data              = ''
-      @charset           = 'UTF-8'
-      @host              = ''
-      @force_show_code   = false
-      @multi_site        = false
-      @is_static         = false
-      @tl_user           = ''
-      @verbose           = false
-      @test              = false
-      self.isrobot = false
-      host = nil
-      self.request=request
-      @tl_user=user
-      
-      raise_error("User is not defined")         && return if @tl_user.blank?
-      raise_error("Request env is not provided") && return if @request.blank?
-
-      unless options.is_a?(Hash)
-        host = options
-        options = {}
-      end
-
-      host ||= options[:host]
-
-      @host = host.present? ? host : (self.request.host rescue nil)
-      @host = @host.gsub(/^https?:\/\//i, '').gsub(/^www\./i, '').downcase if @host.present?
-
-      @is_static = options[:is_static].present?
-
-      self.request_uri = options[:request_uri].present? ? options[:request_uri] : (self.request.path rescue nil)
-      self.request_uri = self.request_uri.gsub(/\?.*$/, '').gsub(/\/+/, '/') if @is_static && self.request_uri.present?
-
-
-      @app_folder = options[:app_folder] if options[:app_folder].present?
-      @data_folder = options[:data_folder] if options[:data_folder].present?
-      @multi_site = options[:multi_site].present?
-      @verbose = options[:verbose].present? || (self.links['__trustlink_debug__'].present? rescue false)
-      @charset = options[:charset] if options[:charset].present?
-      self.skip_load_links = options[:skip_load_links] if options[:skip_load_links].present?
-      @force_show_code = options[:force_show_code].present? || (self.links['__trustlink_debug__'].present? rescue false)
-
-      if self.request.env['HTTP_TRUSTLINK'] == @tl_user
-        @test = true
-        self.isrobot = true
-        @verbose = true
-      end
-
-      if self.request.parameters['trustlink_test'] == @tl_user
-        @force_show_code=true
-        @verbose = true
-      end
-
-      self.load_links unless self.skip_load_links
-    end
-
-
-
-    def load_links
-      links_db_file = File.join(@app_folder, @data_folder, @tl_user, '/trustlink.links.db')
-      links_db_file = File.join(@app_folder, @data_folder, @tl_user, '/trustlink.'+@host+'.links.db') if @multi_site
-
-      if !File.exist?(links_db_file)
-        begin
-          if FileUtils.touch(links_db_file)
-            File.utime(Time.now, Time.now - CACHE_LIFETIME,links_db_file)
-            File.chmod(0666, links_db_file);
-          else
-            return self.raise_error("There is no file "+links_db_file+". Fail to create. Set mode to 777 on the folder.")
-          end
-        rescue Errno::ENOENT
-          return self.raise_error("Can't create #{links_db_file} file. Check if #{@user} folder exist in #{@data_folder}.")
-        end
-      end
-
-      if !File.writable?(links_db_file)
-        self.raise_error("There is no permissions to write: "+links_db_file+"! Set mode to 777 on the folder.")
-      end
-
-
-      if File.mtime(links_db_file) < (Time.now-CACHE_LIFETIME) || (File.mtime(links_db_file) < (Time.now-CACHE_RELOADTIME) && (File.size(links_db_file) == 0))
-        FileUtils.touch(links_db_file)
-
-        path = '/'+@tl_user+'/'+@host.downcase+'/'+@charset.upcase
-
-        if links = self.fetch_remote_file(SERVER, path)
-          if links[0,12] == 'FATAL ERROR:'
-            self.raise_error(links)
-          else
-            if !(@data = PHP.unserialize(links))
-              self.links = {}
-              self.raise_error("Cann't unserialize data from file.")
-            end
-            self.write(links_db_file, @data)
-          end
-        end
-      end
-
-      @data = self.read(links_db_file) if @data.blank?
-      self.links = @data
-
-      if self.links.blank?
-        self.links = {}
-        self.raise_error("Empty file.")
-      end
-
-      self.file_change_date = File.mtime(links_db_file)
-      self.file_size = self.links.size
-      self.links_page = []
-
-      if @test
-        TEST_COUNT.times do
-          self.links_page << self.links['__test_tl_link__']
-        end
-      else
-        self.links_page = self.links[self.request_uri]
-        self.links_page = [] if self.links_page.blank?
-      end
-
-      self.links_count = self.links_page.size
-    end
-
-    def build_links n = nil
-
-      return self.error if has_errors?
-
-      total_page_links = self.links_page.size
-
-      n = total_page_links if n.to_i<=0 || n.to_i > total_page_links
-
-      res_links = self.links_page[0,n.to_i]
-
-      result = ''
-
-      if self.links['__trustlink_start__'].present? && ((self.links['__trustlink_robots__'] || []).include?(self.request.remote_addr) || @force_show_code)
-        result += self.links['__trustlink_start__']
-      end
-
-      begin
-        tpl_filename = File.join(@app_folder, @data_folder, @tl_user, TEMPLATE+'.tpl.html')
-        tpl = read_raw(tpl_filename)
-      rescue Errno::ENOENT
-        raise_error("Template file not found")
-        return self.error
-      end
-
-      block = ''
-      if !tpl=~/\<\{block\}\>.+\<\{\/block\}\>/
-        raise_error("Wrong template format: no <{block}><{/block}> tags")
-      else
-        tpl.sub!(/\<\{block\}\>(.+)\<\{\/block\}\>/im){block = $1; '%s'}
-        raise_error("Wrong template format: no <{head_block}> tag.") if !block.include?('<{head_block}>')
-        raise_error("Wrong template format: no <{/head_block}> tag.") if !block.include?('<{/head_block}>')
-        raise_error("Wrong template format: no <{link}> tag.") if !block.include?('<{link}>')
-        raise_error("Wrong template format: no <{text}> tag.") if !block.include?('<{text}>')
-        raise_error("Wrong template format: no <{host}> tag.") if !block.include?('<{host}>')
-      end
-
-      links_block = ''
-
-      res_links.each do |link|
-        raise_error("format of link must be an array('anchor'=>anchor,'url'=>url,'text'=>text") if link.blank? || link['text'].blank? || link['url'].blank?
-        parsed_host=extract_host(link['url'])
-        if parsed_host.blank?
-          raise_error("wrong format of url: "+link['url'])
-        else
-          level=parsed_host.split('.').size
-          raise_error("wrong host: #{parsed_host} in url #{link['url']}") if level<2
-        end
-        unless has_errors?
-          host=parsed_host.sub('www.','').downcase
-          tmp_block = block.sub("<{host}>", host)
-          if link['anchor'].blank?
-            tmp_block.sub!(/\<\{head_block\}\>(.+)\<\{\/head_block\}\>/is, "")
-          else
-            href = link['punicode_url'].blank? ? link['url'] : link['punicode_url']
-            tmp_block.sub!("<{link}>", '<a href="'+href+'">'+link['anchor']+'</a>')
-            tmp_block.sub!("<{head_block}>", '')
-            tmp_block.sub!("<{/head_block}>", '')
-          end
-          tmp_block.sub!("<{text}>", link['text'])
-          links_block << tmp_block
-        else
-          result += self.error 
-        end
-      end
-
-      if (self.links['__trustlink_robots__'] || []).include?(self.request.remote_addr) || @verbose
-
-        result += self.error.to_s
-
-        result += '<!--REQUEST_URI='+self.request.path+"-->\n"
-        result += "\n<!--\n"
-        result += 'L '+VERSION+"\n"
-        result += 'REMOTE_ADDR='+self.request.remote_addr+"\n"
-        result += 'request_uri='+self.request_uri+"\n"
-        result += 'charset='+@charset+"\n"
-        result += 'is_static='+@is_static.to_s+"\n"
-        result += 'multi_site='+@multi_site.to_s+"\n"
-        result += 'file change date='+self.file_change_date.to_s+"\n"
-        result += 'lc_file_size='+self.file_size.to_s+"\n"
-        result += 'lc_links_count='+self.links_count.to_s+"\n"
-        result += 'left_links_count='+self.links_page.size.to_s+"\n"
-        result += 'n='+n.to_s+"\n"
-        result += '-->'
-      end
-
-      if res_links.present? && res_links.size>0
-        tpl = sprintf(tpl, links_block)
-        result += tpl
-      end
-
-      if self.links['__trustlink_end__'].present? && ((self.links['__trustlink_robots__'] || []).include?(self.request.remote_addr) || @force_show_code)
-        result += self.links['__trustlink_end__']
-      end
-
-      result = '<noindex>'+result+'</noindex>' if (@test && !self.isrobot)
-
-      result.force_encoding(@charset)
-    end
-
-
-    def fetch_remote_file host, path
-      user_agent = 'Trustlink Client RoR ' + VERSION
-      resp=Net::HTTP.start(host) { |http|
-        http.get(path)
-      }
-      if resp.body
-        resp.body.force_encoding(@charset)
-      else
-        self.raise_error("Can't connect to server: "+host+path)
-      end
-    end
-
-
-    def read filename
-      Marshal.load(read_raw filename)
-    end
-
-    def read_raw filename
-      open(filename, "rb") { |file|
-        file.read
-      }
-    end
-
-    def write filename, data
-      write_raw(filename, Marshal.dump(data))
-    end
-
-    def write_raw filename, data
-      open(filename, "wb") { |file|
-        file.write(data)
-      }
-    end
-
-    def raise_error msg
-      self.error ||= ''
-      self.error << "<!--ERROR: #{msg}-->\n"
-    end
+  require 'trustlink/railtie' if defined?(Rails)
+  require 'app/helpers/trustlink_helper'
 
-    def has_errors?
-      self.error.present?
-    end
+  path = File.join(File.dirname(__FILE__), 'app', 'models')
+  $LOAD_PATH << path
 
-    def extract_host(url)
-      if url =~ %r{^(?:https?://)?(?:www.)?([^/]+)(?:/|$)}
-        $1
-      else
-        ""
-      end
-    end
-  end
+  ActiveSupport::Dependencies.autoload_paths << path
+  ActiveSupport::Dependencies.autoload_once_paths.delete(path)
+  ActionView::Base.send :include, TrustlinkHelper
+  ActionController::Base.prepend_view_path File.join(File.dirname(__FILE__), 'app/views')
 end