easy_sitemap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aaf66bb4a6ba700872042b3ccdcf77183e73e2b18d4da3f8abd3db27d2cb65b0
+  data.tar.gz: '078063ff7007c1ea296ee78b38901eb64f7f5f53d0e490b708b46cf098f61c59'
+SHA512:
+  metadata.gz: 10121f35cf43d2a31aabf55c11eca85f4ee09b81443376b2952ccd9b624cdf11ffdbdaec47ac01145e9df3ba0052d3ee36c4d5e35b4acf23b412e4bacc35a119
+  data.tar.gz: ac3c2c0126a5959ab8e749fad871f6b4764fd50afdbe1815326c953fd4756dfe16fc2d8c420f8917551c58748b1d897aec8b8029642804b7836bd400d2d67849

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [Unreleased]
+
+- Increase version
+- Release it
+
+## [1.0.0.beta] - 2020-07-13
+### Added
+- Created EasySitemap

data/README.md

@@ -0,0 +1,47 @@
+# EasySitemap
+
+<!--
+  -- Replace for true repository location
+  --
+[![coverage report](https://git.easy.cz/rysy/features/easy_sitemap/badges/master/coverage.svg)](https://git.easy.cz/rysy/features/easy_sitemap/commits/master)
+  --
+-->
+
+## How to install
+
+Add to your Gemfile or gems.rb
+
+```ruby
+# From gems server
+source 'https://gems.easysoftware.com' do
+  gem 'easy_sitemap'
+end
+
+# From git server
+gem 'easy_sitemap', git: 'git@git.easy.cz:rysy/features/easy_sitemap.git', branch: 'master'
+```
+
+## Development
+
+Please follow our [Guidelines](https://git.easy.cz/external/guidelines/wikis/home)
+
+For full feature list of RYS see [RYS wiki](https://github.com/easysoftware/rys/wiki)
+
+### 1) From the platform gemfile
+
+1. Open gemfile (e.g: APP_ROOT/Gemfile.local)
+2. Add `gem 'easy_sitemap', path: GENERATED_RYS_LOCATION`
+3. Run `bundle install`
+4. Run the server and develop
+
+### 2) Link to redmine plugin
+
+1. Make a symlink into `plugins/easysoftware/local`
+2. Run `bundle install`
+3. Run the server and develop
+
+### 3) From generated rys itself
+
+1. Symlink the platform (dummy app) into `test/dummy`
+2. Run `bundle install`
+3. Run the server and develop

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+
+possible_app_dirs = [
+  ENV['DUMMY_PATH'],
+  File.join(Dir.pwd, 'test/dummy')
+]
+dir = possible_app_dirs.compact.first
+
+if !File.directory?(dir)
+  abort("Directory '#{dir}' does not exists")
+end
+
+APP_RAKEFILE = File.expand_path(File.join(dir, 'Rakefile'), __dir__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks

data/bin/generate

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+lib_path = File.expand_path('../../lib', __FILE__)
+$:.unshift(lib_path)
+
+require "bundler/setup"
+require 'optparse'
+require "easy_sitemap"
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: bin/generate [options]"
+
+  opts.on('-f', '--filename NAME', 'Path or file name of created XML file') { |v| options[:filename] = v }
+end.parse!
+
+EasySitemap.create(options[:filename] || 'sitemap.xml')

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/blorgh/engine', __dir__)
+APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/runner

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+lib_path = File.expand_path('../../lib', __FILE__)
+$:.unshift(lib_path)
+
+require "bundler/setup"
+require 'optparse'
+require "nokogiri"
+require "httparty"
+require 'active_support/all'
+require "easy_sitemap/runner"
+require "easy_sitemap/parser"
+require "pp"
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: bin/generate [options]"
+
+  opts.on('-f', '--filename NAME', 'Path or file name of created XML file') { |v| options[:filename] = v }
+  opts.on('-c', '--thread_count NUMBER', 'Thread count') { |v| options[:thread_count] = v.to_i }
+  opts.on('-k', '--api_key API_KEY', 'Api key to Redmine') { |v| options[:api_key] = v }
+end.parse!
+
+result = EasySitemap::Runner.perform(**options)
+pp EasySitemap::Parser.group_result(result)

data/lib/easy_sitemap.rb

@@ -0,0 +1,22 @@
+require 'nokogiri'
+require 'httparty'
+
+require 'easy_sitemap/version'
+require 'easy_sitemap/engine'
+
+module EasySitemap
+
+  autoload :Generator, "easy_sitemap/generator"
+  autoload :Runner, "easy_sitemap/runner"
+  autoload :Parser, "easy_sitemap/parser"
+
+  def self.create(file_path)
+    f = File.open(file_path, "w")
+    generator = Generator.new(::Issue.on_active_project)
+    #generator = Generator.new(::Issue.limit(10))
+    f.write(generator.to_xml)
+  ensure
+    f.close
+  end
+
+end

data/lib/easy_sitemap/engine.rb

@@ -0,0 +1,7 @@
+module EasySitemap
+  class Engine < ::Rails::Engine
+    initializer 'easy_sitemap.setup' do
+      # Custom initializer
+    end
+  end
+end

data/lib/easy_sitemap/generator.rb

@@ -0,0 +1,40 @@
+module EasySitemap
+  class Generator
+
+    def initialize(entities_scope, options = {})
+      @entities_scope = entities_scope
+      @options = options
+    end
+
+    def to_xml
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.urlset do
+          @entities_scope.find_each(batch_size: 1) do |entity|
+            xml.url do
+              xml.loc url(entity)
+              if entity.respond_to?(:updated_at)
+                xml.lastmod entity.updated_at
+              elsif entity.respond_to?(:updated_on)
+                xml.lastmod entity.updated_on
+              end
+            end
+          end
+        end
+      end
+      builder.to_xml
+    end
+
+    protected
+
+    def url(entity)
+      u = [@options[:host] || "http://localhost:3000"]
+      u << case entity
+           when Issue
+             "issues"
+           end
+      u << entity.id
+      u.join("/")
+    end
+
+  end
+end

data/lib/easy_sitemap/parser.rb

@@ -0,0 +1,10 @@
+module EasySitemap
+  class Parser
+
+    def self.group_result(result)
+      Hash[*result.group_by { |k, v| v["status"] }.map { |key, items| [key, items.count] }.flatten]
+    end
+
+  end
+end
+

data/lib/easy_sitemap/runner.rb

@@ -0,0 +1,57 @@
+module EasySitemap
+  class Runner
+
+    attr_reader :result
+
+    def initialize(urls, api_key: nil)
+      @urls = urls
+      @api_key = api_key
+      @result = {}
+    end
+
+    def self.perform(filename: 'sitemap.xml', thread_count: 5, api_key: nil)
+      doc = File.open(filename) { |f| Nokogiri::XML(f) }
+
+      runners = doc.xpath("//loc").
+          map(&:text).
+          in_groups(thread_count, false).
+          map { |group| Runner.new(group, api_key: api_key) }
+
+      threads = runners.map { |runner| Thread.new { runner.perform } }
+      threads.each { |thr| thr.join }
+
+      runners.map(&:result).inject(:merge)
+    end
+
+    def perform
+      @urls.each do |url|
+        ping_url(url)
+      end
+    end
+
+    private
+
+    def ping_url(url)
+      r = {}
+
+      starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+      begin
+        h = {}
+        h['X-Redmine-API-Key'] = @api_key if @api_key.present?
+
+        response = HTTParty.get(url, follow_redirects: false, headers: h)
+
+        r['status'] = response.code
+      rescue Errno::ECONNREFUSED
+        r['status'] = 410
+      end
+
+      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      r['time'] = (ending - starting).round(2)
+
+      @result[url] = r
+    end
+
+  end
+end

data/lib/easy_sitemap/version.rb

@@ -0,0 +1,3 @@
+module EasySitemap
+  VERSION = '0.0.1'
+end

data/lib/tasks/easy_sitemap_tasks.rake

@@ -0,0 +1,27 @@
+begin
+  require 'rspec/core/rake_task'
+
+  namespace :easy_sitemap do
+    desc 'Runs rspec tests'
+    RSpec::Core::RakeTask.new(:spec) do |task, _task_args|
+      args = []
+      args << '--require' << Ryspec::Engine.root.join('spec/spec_helper')
+
+      task.rspec_opts = args
+      task.pattern = EasySitemap::Engine.root.join('spec/**/*_spec.rb')
+    end
+
+    desc <<-END_DESC
+    Generate sitemap from DB
+
+    Example:
+      bundle exec rails easy_sitemap:generate filename="path_or_file_name"
+    END_DESC
+    task :generate => :environment do
+      EasySitemap.create(ENV['filename'].presence || 'sitemap.xml')
+    end
+
+  end
+rescue StandardError, LoadError
+  # Ignore when `ryspec` gem missing
+end

data/spec/factories/factory.rb

@@ -0,0 +1,7 @@
+# FactoryBot.define do
+#
+#   factory :test do
+#     sequence(:name) { |n| "Test ##{n}" }
+#   end
+#
+# end

data/spec/features/feature_spec.rb

@@ -0,0 +1,6 @@
+# RSpec.feature 'Feature test', js: true do
+#
+#   scenario 'Scenario' do
+#   end
+#
+# end

data/spec/models/model_spec.rb

@@ -0,0 +1,7 @@
+# RSpec.describe 'Model test', logged: :admin do
+#
+#   it 'Test something' do
+#     expect(1).to eq(1)
+#   end
+#
+# end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler'
+
+spec = Bundler.load.specs.find { |s| s.name.to_s == 'ryspec' }
+
+if !spec
+  abort('Gem ryspec was not found. Please add it and run bundle install again.')
+end
+
+require File.join(spec.full_gem_path, 'spec/spec_helper')

data/spec/support/support.rb

@@ -0,0 +1,6 @@
+module EasySitemap
+  module Test
+    module Helper
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: easy_sitemap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- petr@easy.cz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Description of EasySitemap.
+email:
+- info@easysoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- Rakefile
+- bin/generate
+- bin/rails
+- bin/runner
+- lib/easy_sitemap.rb
+- lib/easy_sitemap/engine.rb
+- lib/easy_sitemap/generator.rb
+- lib/easy_sitemap/parser.rb
+- lib/easy_sitemap/runner.rb
+- lib/easy_sitemap/version.rb
+- lib/tasks/easy_sitemap_tasks.rake
+- spec/factories/factory.rb
+- spec/features/feature_spec.rb
+- spec/models/model_spec.rb
+- spec/spec_helper.rb
+- spec/support/support.rb
+homepage: https://easysoftware.com
+licenses:
+- GPL-2.0-or-later
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Summary of EasySitemap.
+test_files:
+- spec/factories/factory.rb
+- spec/support/support.rb
+- spec/models/model_spec.rb
+- spec/spec_helper.rb
+- spec/features/feature_spec.rb