sucharyruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9663196acab2c9f57826c543809e4647c5bf6a289e25c3b5992bde463a19e40f
+  data.tar.gz: fb21ddae8fffd21afa363eaae47dd05f87b9dd8508aab3818c2f9cc6dc9b490f
+SHA512:
+  metadata.gz: eb44365a90ebc3c6c3ef55a2f29f9f6a7aed9aab1e57d3fe5fa5a2eb0f87a430fa1e8f6d54929f5989730c9bb90ec5486c0bc162b3de0b71484aa75990db13f1
+  data.tar.gz: b32e8002226d10c301e560388a8091a7f654e03882756b42103807b9df49820596dd92b773efbd698f6ea4086d592a0a5696fdee852e92fc10e70f267a996174

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 SucharyAPI
+
+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,110 @@
+# SucharyPL - oficjalna biblioteka bazy SucharyAPI
+Rubyowa biblioteka do pobierania kawałów z ogólnopolskiej bazy SucharyAPI
+
+[![Ruby Version](https://img.shields.io/badge/ruby-2.7%2B-red)](https://www.ruby-lang.org/)
+[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+---
+
+## 🚀 Instalacja
+### Za pomocą gem
+
+```bash
+gem install sucharyruby
+```
+
+### Za pomocą Bundlera
+
+(W pliku Gemfile)
+```ruby
+gem "sucharyruby"
+```
+
+albo w nowym Bundlerze:
+(komenda)
+```bash
+bundle add sucharyruby
+```
+
+---
+
+## ⚡ Szybki start
+### Pobranie losowego suchara
+
+```ruby
+require "sucharyruby"
+
+suchar = Sucharyruby.dajKawal
+puts suchar
+```
+
+### Pobranie suchara z konkretnej kategorii
+
+```ruby
+require "sucharyruby"
+
+# Możesz użyć ciągu znaków:
+suchar = Sucharyruby.dajKawal("programowanie")
+
+# Albo użyć stałej z klasy Kategoria:
+suchar = Sucharyruby.dajKawal(Sucharyruby::Kategoria::PROGRAMOWANIE)
+
+puts suchar
+```
+
+---
+
+## Kategorie
+- `"programowanie"` - Suchary o programowaniu
+- `"dwuznaczne"` - Suchary dwuznaczne
+- `"szkolne"` - Suchary szkolne
+- `"suchary"` - Ogólne suchary
+- `"wulgarne"` - Suchary wulgarne
+- `"czarnyhumor"` - Czarny humor
+- `"inne"` - Inne kategorie
+
+---
+
+## 🛡️ Obsługa błędów
+
+Biblioteka rzuca sformalizowane wyjątki, które możesz łatwo obsługiwać:
+
+### Dostępne wyjątki
+
+- `Sucharyruby::SucharyError` - Bazowy wyjątek, rodzic wszystkich błędów z biblioteki
+- `Sucharyruby::KategoriaError` - Nieprawidłowa kategoria
+- `Sucharyruby::ConnectionError` - Problemy z połączeniem (brak internetu, timeout)
+- `Sucharyruby::HTTPError` - Błędy serwera (np. 404 dla nieistniejącej kategorii)
+- `Sucharyruby::TimeoutError` - Przekroczony limit czasu zapytania
+
+### Przykład obsługi błędów
+
+```ruby
+require "sucharyruby"
+
+begin
+  suchar = Sucharyruby.dajKawal("programowanie")
+  puts suchar
+rescue Sucharyruby::ConnectionError
+  puts "❌ Błąd połączenia - sprawdź połączenie internetowe!"
+rescue Sucharyruby::HTTPError => e
+  puts "❌ Błąd serwera: #{e.status} - #{e.message}"
+rescue Sucharyruby::KategoriaError => e
+  puts "❌ Nieprawidłowa kategoria: #{e.message}"
+rescue Sucharyruby::SucharyError => e
+  puts "❌ Nieoczekiwany błąd: #{e.message}"
+end
+```
+
+---
+
+## 📡 API
+
+Biblioteka jest produktem oraz korzysta z oficjalnej bazy SucharyAPI:
+🔗 https://sucharyapi.onrender.com
+
+---
+
+## 📝 Licencja
+
+MIT

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/example/example.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "sucharyruby"
+
+puts "=== SucharyPL - Przykłady Użycia ==="
+
+# 1. Losowy suchar
+puts "\n1. Losowy suchar:"
+puts Sucharyruby.dajKawal
+
+# 2. Suchar z kategorii za pomocą stałej
+puts "\n2. Suchar z kategorii (programowanie):"
+suchar_dev = Sucharyruby.dajKawal(Sucharyruby::Kategoria::PROGRAMOWANIE)
+puts suchar_dev
+
+# 3. Obsługa błędów
+puts "\n3. Przykład obsługi błędnej kategorii:"
+begin
+  Sucharyruby.dajKawal("nieznana_kategoria")
+rescue Sucharyruby::KategoriaError => e
+  puts "Wyłapano błąd kategorii: #{e.message}"
+rescue Sucharyruby::SucharyError => e
+  puts "Wyłapano ogólny błąd biblioteki: #{e.message}"
+end

data/lib/sucharyruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Sucharyruby
+  VERSION = "1.0.0"
+end

data/lib/sucharyruby.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "uri"
+
+require_relative "sucharyruby/version"
+
+module Sucharyruby
+  # Kategorie
+  class Kategoria
+    PROGRAMOWANIE = "programowanie"
+    DWUZNACZNE    = "dwuznaczne"
+    SZKOLNE       = "szkolne"
+    SUCHARY       = "suchary"
+    WULGARNE      = "wulgarne"
+    CZARNYHUMOR   = "czarnyhumor"
+    INNE          = "inne"
+
+    WSZYSTKIE = [
+      PROGRAMOWANIE,
+      DWUZNACZNE,
+      SZKOLNE,
+      SUCHARY,
+      WULGARNE,
+      CZARNYHUMOR,
+      INNE
+    ].freeze
+
+    def self.poprawna?(kategoria)
+      WSZYSTKIE.include?(kategoria.to_s)
+    end
+  end
+
+  # Customowe błędy
+  class SucharyError < StandardError; end
+  class KategoriaError < SucharyError; end
+  class ConnectionError < SucharyError; end
+  class HTTPError < SucharyError
+    attr_reader :status
+    def initialize(status, wiadomosc)
+      @status = status
+      super(wiadomosc)
+    end
+  end
+  class TimeoutError < SucharyError; end
+
+  # Główna funkcja
+  def self.dajKawal(kategoria = nil)
+    if kategoria
+      kat_str = kategoria.to_s.downcase
+      if not(Kategoria.poprawna?(kat_str))
+        raise KategoriaError, "Nieprawidłowa kategoria: #{kategoria}"
+      else
+        url = "https://sucharyapi.onrender.com/#{kat_str}"
+      end
+    else
+      url = "https://sucharyapi.onrender.com"
+    end
+
+    begin
+      adres = URI.parse(url)
+      http = Net::HTTP.new(adres.host, adres.port)
+      http.use_ssl = (adres.scheme == "https")
+      http.open_timeout = 6.5
+      http.read_timeout = 6.5
+      odpowiedz = http.request(Net::HTTP::Get.new(adres))
+      if odpowiedz.is_a?(Net::HTTPSuccess)
+        dane = JSON.parse(odpowiedz.body)
+        zart = dane["tresc"]
+        return zart
+      else
+        raise HTTPError.new(odpowiedz.code.to_i, "Serwer zwrócił kod błędu #{odpowiedz.code}")
+      end
+    rescue Net::OpenTimeout, Net::ReadTimeout => e
+      raise TimeoutError, "Zapytanie przekroczyło limit czasu: #{e.message}"
+    rescue SocketError, Errno::ECONNREFUSED => e
+      raise ConnectionError, "Błąd połączenia z serwerem: #{e.message}"
+    rescue JSON::ParserError => e
+      raise SucharyError, "Otrzymano niepoprawny format danych z serwera: #{e.message}"
+    end
+  end
+end

data/sig/sucharyruby.rbs

@@ -0,0 +1,4 @@
+module Sucharyruby
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: sucharyruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- SucharyAPI
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+email:
+- sucharyapi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- example/example.rb
+- lib/sucharyruby.rb
+- lib/sucharyruby/version.rb
+- sig/sucharyruby.rbs
+homepage: https://github.com/SucharyAPI/sucharypl-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SucharyAPI/sucharypl-ruby
+  source_code_uri: https://github.com/SucharyAPI/sucharypl-ruby
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.17
+specification_version: 4
+summary: Oficjalna biblioteka bazy SucharyAPI dla Ruby
+test_files: []