zypper-onlinesearch 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4fb320a7be8ac2fc8adcc67f3de65cdf424dc8cf27a1a76d3fca6ea251164537
+  data.tar.gz: caed75b0b715d1f98f1dcc84f8388cf95ecadc0776902c151ebb3267c4f9fbf2
+SHA512:
+  metadata.gz: b6698b420ce6f61e8b6719775f8924e28c6be832f2f1e100e4c77d2cf3feddbfab4c45b2fa6ae1bbeb2d07cb57889901e2c76f5eb67f55b640a35c679911e1ea
+  data.tar.gz: 45fc3cf71baa2d105270c16a136bbccd097e7cc2f7c11cb7c9f5207210462637391c7aa6db6c8f240a38af7a06ae5341e57d2c01ab891c9463d46a4581e28eec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.5
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fabio.mucciante@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in zypper-onlinesearch.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    zypper-onlinesearch (1.0.0)
+      iniparse
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    iniparse (1.5.0)
+    mini_portile2 (2.8.1)
+    nokogiri (1.13.10)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    racc (1.6.2)
+    rake (12.3.3)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  zypper-onlinesearch!
+
+BUNDLED WITH
+   2.4.3

data/README.md

@@ -0,0 +1,162 @@
+# Zypper-Onlinesearch
+
+Zypper-Onlinesearch brings the ability to find packages from *software.opensuse.org* and *Packman*,
+directly in your terminal.
+
+Basically it is just a command-line frontend to these search engines, it executes a query to them,
+arrange the results and display them in a table or report view.
+
+## Installation
+
+There are a couple of options to install this application.
+
+### Rubygem
+
+Install it as a regular Ruby gem with:
+```shell
+$ gem install zypper-onlinesearch
+```
+
+### From the openSUSE Build Service repository
+
+This application has been packaged in my personal OBS repository so you can install It
+as a common RPM package:
+- Add the repository URL in your list;
+- install the package from Yast or Zypper.
+
+Being the repository URL slightly changing from a version to another, I included all the steps
+in the related [project page][project_page] at my blog.
+
+## Usage
+
+To query for the string :
+```shell
+$ onlinesearch -s <string>
+```
+
+When the pages are returnerd they are identified in the *Page* field and can be read with the `-p` switch:
+```shell
+$ onlinesearch -p <page>
+```
+
+To list the links from that page:
+```shell
+$ onlinesearch -l <page>,<link_number>
+```
+
+For example looking for *Qmmp*:
+```shell
+$ onlinesearch -s qmmp
+
+====================================================================================================
+Parameters: Engine: packman | Query: qmmp | Cache: On (2023-02-23 16:37)
+====================================================================================================
+    # |       Page       | Description 
+----------------------------------------------------------------------------------------------------
+    1 | qmmp             | Qt-based Multimedia Player
+----------------------------------------------------------------------------------------------------
+    2 | qmmp-plugin-pack | Extra plugins for Qmmp
+----------------------------------------------------------------------------------------------------
+
+====================================================================================================
+Parameters: Engine: opensuse | Query: qmmp | Cache: On (2023-02-23 16:37)
+====================================================================================================
+    # |              Page              | Description 
+----------------------------------------------------------------------------------------------------
+    1 | qmmp                            | Qt-based Multimedia Player
+----------------------------------------------------------------------------------------------------
+    2 | libqmmp1                        | Qmmp library
+----------------------------------------------------------------------------------------------------
+    3 | libqmmp-devel                   | Development files for libqmmp
+----------------------------------------------------------------------------------------------------
+...
+```
+
+We get among the results a page called *qmmp* for both engines, so to read that pages:
+```shell
+$ onlinesearch -p qmmp
+
+====================================================================================================
+Parameters:  Engine: packman | OS: openSUSE Leap 15.4 | Architecture: 64 Bit | Cache: On (2023-02-07 16:57)
+====================================================================================================
+Name:        qmmp
+Summary:     
+Description: 
+Qt-based Multimedia Player
+----------------------------------------------------------------------------------------------------
+    # | Version |  Repo   |        Distro       
+----------------------------------------------------------------------------------------------------
+    1 |   2.1.2 | Packman | openSUSE Leap 15.4
+----------------------------------------------------------------------------------------------------
+
+====================================================================================================
+Parameters:  Engine: opensuse | OS: openSUSE Leap 15.4 | Architecture: 64 Bit | Cache: On (2023-02-07 16:57)
+====================================================================================================
+Name:        qmmp
+Summary:     Qt-based Multimedia Player
+Description: This program is an audio-player, written with help of Qt library.
+----------------------------------------------------------------------------------------------------
+    # | Version |         Repo          |        Distro       
+----------------------------------------------------------------------------------------------------
+    1 |   2.1.2 | home:plater           | openSUSE Leap 15.4
+----------------------------------------------------------------------------------------------------
+    2 |   1.4.4 | home:ykoba:multimedia | openSUSE Leap 15.4
+----------------------------------------------------------------------------------------------------
+    3 |   2.1.2 | multimedia:apps       | openSUSE Leap 15.4
+----------------------------------------------------------------------------------------------------
+```
+
+To show the page from one engine only, just append the `--engine <engine_name>` param:
+```shell
+$ onlinesearch -p qmmp --engine opensuse
+```
+
+To list the links in the third repository listed in the *opensuse* engine:
+```shell
+$ onlinesearch -l qmmp,3 --engine opensuse
+
+====================================================================================================
+Parameters:  Engine: opensuse | OS: openSUSE Leap 15.4 | Architecture: 64 Bit | Cache: On (2023-02-07 16:57)
+====================================================================================================
+Name:        qmmp
+Summary:     Qt-based Multimedia Player
+Description: This program is an audio-player, written with help of Qt library.
+----------------------------------------------------------------------------------------------------
+    # | Format | Link
+----------------------------------------------------------------------------------------------------
+    1 |    ymp | https://software.opensuse.org/ymp/multimedia:apps/15.4/qmmp.ymp?base=openSUSE%3ALeap%3A15.4&query=qmmp
+----------------------------------------------------------------------------------------------------
+    2 |    src | https://download.opensuse.org/repositories/multimedia:/apps/15.4/src/qmmp-2.1.2-lp154.182.3.src.rpm
+----------------------------------------------------------------------------------------------------
+    3 | x86_64 | https://download.opensuse.org/repositories/multimedia:/apps/15.4/x86_64/qmmp-2.1.2-lp154.182.3.x86_64.rpm
+----------------------------------------------------------------------------------------------------
+```
+
+To print only the raw URLs:
+```shell
+$ onlinesearch -l qmmp,3 --urls
+https://software.opensuse.org/ymp/multimedia:apps/15.4/qmmp.ymp?base=openSUSE%3ALeap%3A15.4&query=qmmp
+https://download.opensuse.org/repositories/multimedia:/apps/15.4/src/qmmp-2.1.2-lp154.182.3.src.rpm
+https://download.opensuse.org/repositories/multimedia:/apps/15.4/x86_64/qmmp-2.1.2-lp154.182.3.x86_64.rpm
+```
+
+And in case we are interested to a specific format:
+```shell
+$ onlinesearch -l qmmp,3 --urls --format ymp
+https://software.opensuse.org/ymp/multimedia:apps/15.4/qmmp.ymp?base=openSUSE%3ALeap%3A15.4&query=qmmp
+```
+
+## Get help
+
+Where to start:
+```shell
+$ onlinesearch --help
+```
+
+## More Help:
+
+More info is available at:
+- the [Zypper-Onlinesearch Project page][project_page].
+
+[project_page]: https://freeaptitude.altervista.org/projects/zypper-onlinesearch.html "Zypper-Onlinesearch project page"
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zypper/onlinesearch"
+
+# 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(__FILE__)

data/bin/setup

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

data/exe/onlinesearch

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "zypper/onlinesearch/cli"
+
+Zypper::Onlinesearch::CLI.start

data/lib/zypper/onlinesearch/cache.rb

@@ -0,0 +1,54 @@
+require 'fileutils'
+require 'uri'
+
+module Zypper
+  module Onlinesearch
+
+    class Cache
+
+      def initialize(operation, engine)
+        @base_folder = File.join(ENV['HOME'], '.cache', 'zypper-onlinesearch', engine, operation)
+        FileUtils.mkdir_p @base_folder unless Dir.exists? @base_folder
+      end
+
+      def set(query, response)
+        File.open(File.join(@base_folder, query_to_filename(query)), 'w+') do |f|
+          f.write Marshal.dump(response)
+        end
+      end
+
+      def get(query)
+        fname = query_to_filename(query)
+        Marshal.load(File.read(File.join(@base_folder, fname))) if exists? query
+      end
+
+      def exists?(query)
+        File.exists?(File.join(@base_folder, query_to_filename(query)))
+      end
+
+      def self.reset!
+        base_folder = File.join(ENV['HOME'], '.cache', 'zypper-onlinesearch')
+        if Dir.exist? base_folder
+          size = Dir.glob(File.join(base_folder, '**', '*')).map{ |f| File.size(f) }.inject(:+)
+          FileUtils.remove_dir base_folder
+          return size
+        else
+          raise EmptyCache
+        end
+      end
+
+      def mtime(query)
+        fname = File.join(@base_folder, query_to_filename(query))
+        File.mtime(fname) if File.exist? fname
+      end
+
+      private
+
+      def query_to_filename(query)
+        URI.encode query.delete('./')
+      end
+    end
+
+  end
+end
+

data/lib/zypper/onlinesearch/cli.rb

@@ -0,0 +1,162 @@
+require 'optparse'
+require 'ostruct'
+require 'zypper/onlinesearch'
+require 'zypper/onlinesearch/version'
+
+module Zypper
+
+  module Onlinesearch
+
+    class OptParseMain
+
+      def self.parse(args)
+        options = OpenStruct.new
+        options.operation = :search
+        options.query = ''
+        options.refresh = false
+        options.engine = :all # :opensuse, :packman
+        options.timeout = 20
+        options.formats = :compatible # :all
+        options.distributions = :compatible # :all
+        options.types = [:supported, :community, :experimental]
+        options.number = 0
+        options.view = :table
+        options.format = :all # or single format
+        #options.preload = nil #used by :links or :page operations
+
+        opt_parser = OptionParser.new do |opt|
+
+          if ENV['ZYPPER_ONLINESEARCH']
+            opt.banner = 'Usage: zypper onlinesearch [OPTIONS] [OPERATION]'
+          else
+            opt.banner = 'Usage: onlinesearch [OPTIONS] [OPERATION]'
+          end
+
+          opt.separator ''
+          opt.separator 'Operations:'
+
+          opt.on('-s', '--search <STRING>', 'Search for STRING to the online engines available') do |o|
+            options.operation = :search
+            options.query = o
+          end
+
+          opt.on('-p', '--page <PAGE_NAME>', 'Get info about the PAGE_NAME') do |o|
+            options.operation = :page
+            options.query = o
+          end
+
+          opt.on('-l', '--links <PAGE_NAME>,<NTH>', Array, 'Print all the links of the NTH item in the PAGE_NAME') do |o|
+            options.operation = :links
+            options.query = o[0]
+            options.number = o[1].to_i
+            #options.preload = :page
+          end
+
+          opt.on('--clean-cache', 'Clean the whole cache') do |o|
+            options.operation = :cache_clean
+          end
+
+          opt.separator ''
+          opt.separator 'General Options'
+
+          opt.on('--engine <ENGINE>', 'Use only ENGINE to search for (default: ' + options.engine.to_s + ', alternatives: ' + Request::Search.constants.map(&:to_s).map(&:downcase).join(', ')  + ')') do |o|
+            options.engine = o.to_sym
+          end
+
+          opt.on('--refresh', 'Refresh the cached values.') do |o|
+            options.refresh = true
+          end
+
+          opt.on('--timeout <SECONDS>', "Adjust the waiting SECONDS used to catch an HTTP Timeout Error (Default: #{options.timeout})") do |o|
+            options.timeout = o.to_f
+          end
+
+          opt.separator ''
+          opt.separator 'View options:'
+
+          opt.on('--table', 'Show the results as a table [DEFAULT]') do |o|
+            options.view = :table
+          end
+
+          opt.on('--report', 'Show the results as report') do |o|
+            options.view = :report
+          end
+
+          opt.separator ''
+          opt.separator '"Page" and "Links" options:'
+
+          opt.on('--all-formats', 'Show all the available formats') do |o|
+            options.formats = :all
+          end
+
+          opt.on('--all-distributions', 'Show all the available distributions') do |o|
+            options.distributions = :all
+          end
+
+          opt.on('--no-supported', 'Hide supported packages.') do |o|
+            options.types.delete :supported
+          end
+
+          opt.on('--no-experimental', 'Hide experimental packages.') do |o|
+            options.types.delete :experimental
+          end
+
+          opt.on('--no-community', 'Hide community packages.') do |o|
+            options.types.delete :community
+          end
+
+          opt.separator ''
+          opt.separator '"Links" options:'
+
+          opt.on('--format FORMAT', 'Filter for packages with the specified FORMAT') do |o|
+            options.format = o.to_sym
+          end
+
+          opt.on('--urls', 'Show only the urls without headers') do |o|
+            options.view = :urls
+          end
+
+          unless ENV['ZYPPER_ONLINESEARCH']
+            opt.separator ''
+            opt.separator 'Other:'
+
+            opt.on_tail('-h', '--help', 'Show this message') do |o|
+              puts opt
+              exit
+            end
+
+            opt.on_tail('-v', '--version', 'Show version') do |o|
+              puts VERSION
+              exit
+            end
+          end
+
+        end
+
+
+        if ARGV.empty?
+          puts opt_parser; exit
+        else
+          opt_parser.parse!(ARGV)
+        end
+
+        options
+      end
+    end
+
+
+    class CLI
+      def self.start
+        begin
+          options = OptParseMain.parse(ARGV)
+          Onlinesearch::Builder.new(options).send(options.operation)
+         rescue => e
+           Messages.error e
+           exit e.error_code
+         end
+      end
+    end
+
+  end
+end
+