organic-sitemap 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25a753e3c05e6d9cc7638560aa7d60291dc41b64
+  data.tar.gz: 08850357c0eda30093911b4a1aa0f5d76c07edd7
+SHA512:
+  metadata.gz: c4c050134631f2f6efda43de0b8658d097e0097f8e6a80f648d48ebeabc97a8dfd89c6bb6b054385380287c3d80148d3de5629ae199f2e35a68d41a026d60b46
+  data.tar.gz: df40f3371fd9cdb9863d49d11852e81223d19b46fada509792de2acc1a1d1c93b829f3e21e50b79a935c7d1c5ec8a0a21dcc181e97b30af40442e4cdc41e4ae9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+organic-sitemap

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in organic-sitemap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Abelardo Gil Maldonado
+
+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,61 @@
+# OrganicSitemap
+OrganicSitemap is a gem that gives you a structure to manage your sitemap with healthy urls. It adds a middleware that save on a expiry set on redis all urls served from your server that meet certain criteria
+
+* *status* **200**
+* Only html pages
+* *method* **GET**
+* Don't match with any of **skypped_urls** Array
+
+## Requisites
+
+**OrganicSitemap** add a middleware on your **Rails** project.
+
+Uses a **Redis** connection to save sitemaps urls
+
+## Installation
+OrganicSearch is not available as a gem yet, you can load it using my github account.
+
+Add in your Gemfile:
+
+```gem 'organic-sitemap', :git => 'git://github.com/abelardogilm/organic-sitemap.git'```
+
+Run ```bundle install.```
+
+## Configuration
+
+To setup this gem you should add your config:
+
+```
+OrganicSitemap.configure do |config|
+  
+  # Add here all regexp you don't want to add on your sitemap
+  # config.skipped_urls = [ "^/sitemap",
+  #                         ".txt$",
+  #                         ".rss$" ] 
+
+  # OrganicSitemap ignore query_params to identify urls. You can add you allowed params
+  # config.allowed_params = [...]
+
+  # By default, all urls are saved on Redis.new(url: 'redis://127.0.0.1:6379'), but you can set you own connection
+  # config.redis_connection = Your redis connection
+
+  # url are saved on a set on redis called "sitemap-urls", but if you want you can change it
+  # config.storage_key = your key
+  
+  # By dafault all url have a expiry time in 7 days, after this time, if no one load this page, it will be removed from the set. To change it (expect number of days):
+  # config.expiry_time = X
+end
+```
+## Rails config generator
+
+Copy base config file on your Rails app by
+
+```rails generator organic_sitemap:config```
+
+## Contribution
+
+If you have cool idea for improving this Gem or any bug fix just open a pull request and I'll be glad to have a look and merge it if seems fine.
+
+## License
+
+This project rocks and uses [MIT-LICENSE](https://github.com/abelardogilm/organic-sitemap/blob/master/LICENSE.txt).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/organic_sitemap/config_generator.rb

@@ -0,0 +1,10 @@
+module OrganicSitemap
+  class ConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "Generates the config initializer file for Organic Sitemap"
+    def copy_initializer_file
+      copy_file "organic_sitemap.rb", "config/initializers/organic_sitemap.rb"
+    end
+  end
+end

data/lib/generators/organic_sitemap/templates/organic_sitemap.rb

@@ -0,0 +1,19 @@
+OrganicSitemap.configure do |config|
+  
+  # Add here all regexp you don't want to add on your sitemap
+  # config.skipped_urls = [ "^/sitemap",
+  #                         ".txt$",
+  #                         ".rss$" ] 
+
+  # OrganicSitemap ignore query_params to identify urls. You can add you allowed params
+  # config.allowed_params = [...]
+
+  # By default, all urls are saved on Redis.new(url: 'redis://127.0.0.1:6379'), but you can set you own connection
+  # config.redis_connection = Your redis connection
+
+  # url are saved on a set on redis called "sitemap-urls", but if you want you can change it
+  # config.storage_key = your key
+  
+  # By dafault all url have a expiry time in 7 days, after this time, if no one load this page, it will be removed from the set. To change it (expect number of days):
+  # config.expiry_time = X
+end

data/lib/organic-sitemap.rb

@@ -0,0 +1,13 @@
+require 'organic-sitemap/version'
+require 'organic-sitemap/redis_manager'
+require 'organic-sitemap/configuration'
+require 'organic-sitemap/url_processor'
+require 'redis'
+
+if defined? Rails
+  require 'organic-sitemap/railtie'
+  require 'organic-sitemap/middleware/url_capture' if defined? Rails
+end
+
+module OrganicSitemap
+end

data/lib/organic-sitemap/configuration.rb

@@ -0,0 +1,24 @@
+module OrganicSitemap
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  class Configuration
+    attr_accessor :storage, :storage_key, :domains, :allowed_params,
+                  :skipped_urls, :redis_connection, :expiry_time
+
+    def initialize
+      @storage          = 'redis'
+      @storage_key      = 'sitemap-urls'
+      @allowed_params   = []
+      @skipped_urls     = []
+      @redis_connection = Redis.new(url: 'redis://127.0.0.1:6379')
+      @expiry_time      = 7
+    end
+  end
+end

data/lib/organic-sitemap/middleware/url_capture.rb

@@ -0,0 +1,18 @@
+module OrganicSitemap
+  module Middleware
+    class UrlCapture
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        status, headers, response = @app.call(env)
+        processor = OrganicSitemap::UrlProcessor.new(status, headers, Rack::Request.new(env))
+        if processor.sitemap_url?
+          OrganicSitemap::RedisManager.add(processor.sanitize_path_info)
+        end
+        [status, headers, response]
+      end
+    end
+  end
+end

data/lib/organic-sitemap/railtie.rb

@@ -0,0 +1,7 @@
+module OrganicSitemap
+  class Railtie < Rails::Railtie
+    initializer "organic-sitemap.insert_middleware" do |app|
+      app.config.middleware.use "OrganicSitemap::Middleware::UrlCapture"
+    end
+  end
+end

data/lib/organic-sitemap/redis_manager.rb

@@ -0,0 +1,30 @@
+module OrganicSitemap
+  class RedisManager
+    def self.add(key)
+      return unless key
+      OrganicSitemap.configuration.
+                    redis_connection.
+                    zadd(OrganicSitemap.configuration.storage_key,
+                         (DateTime.now + OrganicSitemap.configuration.expiry_time.to_i).to_time.to_i,
+                         key)
+    end
+
+    def self.clean_set(time = Time.now)
+      OrganicSitemap.configuration.
+                    redis_connection.
+                    zremrangebyscore(OrganicSitemap.configuration.storage_key,
+                                      "-inf",
+                                      time.to_i)
+    end
+
+    def self.sitemap_urls(from: nil, to: nil)
+      from = from ? from.to_time.to_i : '-inf'
+      to = to ? to.to_time.to_i : '+inf'
+      OrganicSitemap.configuration.
+                    redis_connection.
+                    zrangebyscore(OrganicSitemap.configuration.storage_key,
+                                  from,
+                                  to)
+    end
+  end
+end

data/lib/organic-sitemap/url_processor.rb

@@ -0,0 +1,52 @@
+module OrganicSitemap
+  class UrlProcessor
+
+    attr_accessor :status, :headers, :request
+
+    def initialize(status, headers, request)
+      @status, @headers, @request = status, headers, request
+    end
+
+    def sanitize_path_info
+      query_string = Rack::Utils.parse_nested_query(request.query_string)
+
+      query_string.select!{|x,_| OrganicSitemap.configuration.allowed_params.include? x }
+
+      sanitize_url = request.path
+      sanitize_url << "?#{Rack::Utils.build_query(query_string.sort)}" if query_string.any?
+      sanitize_url
+    rescue => e
+      p "OrganicSitemap ERROR: sanitizing #{request.path} raise error"
+      p "OrganicSitemap ERROR: " + e
+    end
+
+    def sitemap_url?
+      success_response? && html_page? && request.get? && is_expected_domain? && is_allowed_url?
+    end
+
+    private
+
+    def success_response?
+      status == 200
+    end
+
+    def html_page?
+      headers["Content-Type"]["text/html"]
+    end
+
+    def is_expected_domain?
+      # Any domain if not explicitly configured
+      return true if OrganicSitemap.configuration.domains.nil?
+      OrganicSitemap.configuration.domains.include? request.host
+    end
+
+    def is_allowed_url?
+      # Any url if not explicitly configured
+      return true if OrganicSitemap.configuration.skipped_urls.nil?
+      [*OrganicSitemap.configuration.skipped_urls].each do |skip_url|
+        return false if request.path[skip_url]
+      end
+      true
+    end
+  end
+end

data/lib/organic-sitemap/version.rb

@@ -0,0 +1,3 @@
+module OrganicSitemap
+  VERSION = "0.1.1" # First stable version
+end

data/organic_sitemap.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'organic-sitemap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "organic-sitemap"
+  spec.version       = OrganicSitemap::VERSION
+  spec.authors       = ["Kaskito"]
+  spec.email         = ["abelardogilm@gmail.com"]
+
+  spec.summary       = %q{Create your Sitemap in a organic way.}
+  spec.description   = %q{Create your Sitemap in a organic way.}
+  spec.homepage      = "https://github.com/abelardogilm/organic-sitemap/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rack', '~> 1.0', '>= 1.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rspec", '~> 0'
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'simplecov', '~> 0'
+  spec.add_development_dependency 'redis', '~> 0'
+  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'fakeredis', '~> 0'
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: organic-sitemap
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kaskito
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create your Sitemap in a organic way.
+email:
+- abelardogilm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/organic_sitemap/config_generator.rb
+- lib/generators/organic_sitemap/templates/organic_sitemap.rb
+- lib/organic-sitemap.rb
+- lib/organic-sitemap/configuration.rb
+- lib/organic-sitemap/middleware/url_capture.rb
+- lib/organic-sitemap/railtie.rb
+- lib/organic-sitemap/redis_manager.rb
+- lib/organic-sitemap/url_processor.rb
+- lib/organic-sitemap/version.rb
+- organic_sitemap.gemspec
+homepage: https://github.com/abelardogilm/organic-sitemap/
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Create your Sitemap in a organic way.
+test_files: []