wallhavened 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36794ae7b739307ea0af71ef74ebceef6aec55ae0bd6d1f14f676fbd2e58912e
+  data.tar.gz: 2fc86626f4990b814676b017ddf03e9faacf070b695d11e7c3f75bfcf49cb938
+SHA512:
+  metadata.gz: 458d9f2ee3598475a65f5d1e1b0e821948a3f4a3c1ea71634fed1ac5a3cdfe5a30c0711a7e4c71543dc4404240430204acfa94247d21cf8a677e2a3fef6d5fa6
+  data.tar.gz: cbdf3247db9b370fb8168faee95c3020367b72fb34460812992be41f55de16858f3efb991486bee9324f46d77aacbc421f84237000b382fc95a62a96fb3b9872

data/.envrc

@@ -0,0 +1 @@
+use nix

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/README.md

@@ -0,0 +1,31 @@
+# Wallhavened
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/wallhavened`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wallhavened.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/wallhavened

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+
+require_relative "../lib/wallhavened"
+
+require "thor"
+require "cli/ui"
+
+class App < Thor
+  package_name "wallhavened"
+
+  def self.exit_on_failure?
+    true
+  end
+
+  desc "download_all_collections USERNAME API_KEY DIRECTORY", "Download wallpapers from all user collections"
+  method_options username: :string, api_key: :string, directory: :string
+  def download_all_collections(username, api_key, directory)
+    driver = WallhavenAuth.new(username, api_key)
+
+    CLI::UI::Spinner.spin("Collecting collection data...") do |spinner|
+      walls = driver.scrape_all_user_collections
+      walls.each_with_index do |wall, i|
+        spinner.update_title("Downloading wallpapers... [#{i + 1}/#{walls.count}]")
+        wall.download(directory)
+      end
+    end
+    puts "Wallpapers available in #{directory}"
+  end
+
+  desc "download_collection USERNAME API_KEY DIRECTORY", "Download wallpapers from a user collection"
+  method_options username: :string, api_key: :string, directory: :string
+  def download_collection(username, api_key, directory)
+    driver = WallhavenAuth.new(username, api_key)
+
+    collection = CLI::UI::Prompt.ask("Which collection to download?") do |handler|
+      driver.user_collections do |collection|
+        handler.option(collection.label) { collection }
+      end
+    end
+
+    CLI::UI::Spinner.spin("Collecting collection data...") do |spinner|
+      walls = driver.scrape_collection(collection.id)
+      walls.each_with_index do |wall, i|
+        spinner.update_title("Downloading wallpapers... [#{i + 1}/#{walls.count}]")
+        wall.download(directory)
+      end
+    end
+    puts "Wallpapers available in #{directory}"
+  end
+end
+
+CLI::UI::StdoutRouter.enable
+App.start

data/lib/wallhavened/version.rb

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

data/lib/wallhavened/wallhaven.rb

@@ -0,0 +1,82 @@
+require_relative "wallhaven_wallpaper"
+
+require "open-uri"
+require "nokogiri"
+require "json"
+
+class RequestSender
+  def get_json(url)
+    begin
+      json = JSON.parse(URI.parse(url).open.read)
+    rescue OpenURI::HTTPError => e
+      raise e unless e.to_s.include?("429")
+      puts("Delaying for 10s")
+      sleep(10)
+      retry
+    end
+    json
+  end
+end
+
+class Wallhaven
+  SITE_URL = "https://wallhaven.cc".freeze
+  SITE_API = "#{SITE_URL}/api/v1".freeze
+
+  def initialize
+    @request_sender = RequestSender.new
+  end
+end
+
+class Collection
+  attr_reader :id, :label
+
+  def initialize(id, label)
+    @id = id
+    @label = label
+  end
+end
+
+class WallhavenAuth < Wallhaven
+  def initialize(username, api_key)
+    @username = username
+    @api_key = api_key
+    super()
+  end
+
+  def scrape_all_user_collections
+    user_collections.flat_map { |collection| scrape_collection(collection.id) }
+  end
+
+  def user_collections
+    url = "#{SITE_API}/collections?apikey=#{@api_key}"
+    collections = []
+    @request_sender.get_json(url)["data"].each do |collection|
+      collection = Collection.new(collection["id"], collection["label"])
+      yield collection if block_given?
+      collections << collection
+    end
+    collections
+  end
+
+  def scrape_collection(id)
+    max_page = collection_pages_count(id)
+    walls = []
+    (1..max_page).each do |page|
+      walls += scrape_collection_page(id, page)
+      sleep 1.4
+    end
+    walls
+  end
+
+  def collection_pages_count(id)
+    url = "#{SITE_API}/collections/#{@username}/#{id}?page=1"
+    json = @request_sender.get_json(url)
+    json["meta"]["last_page"]
+  end
+
+  def scrape_collection_page(id, page)
+    url = "#{SITE_API}/collections/#{@username}/#{id}?page=#{page}"
+    json = @request_sender.get_json(url)
+    json["data"].map { |wallpaper| WallhavenWallpaper.new(wallpaper["path"], wallpaper["id"]) }
+  end
+end

data/lib/wallhavened/wallhaven_wallpaper.rb

@@ -0,0 +1,18 @@
+class WallhavenWallpaper
+  SITE_URL = "https://wallhaven.cc".freeze
+  attr_reader :url
+
+  def initialize(img_url, id)
+    @img_url = img_url
+    @id = id
+    @filename = img_url.split("/")[-1]
+    puts @filename
+  end
+
+  def download(path)
+    output_path = "#{path}/#{@filename}"
+    URI.parse(@img_url).open do |image|
+      File.binwrite(output_path, image.read)
+    end
+  end
+end

data/lib/wallhavened.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "wallhavened/version"
+require_relative "wallhavened/wallhaven"
+
+module Wallhavened
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/wallhavened.rbs

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

data/wallhavened.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "lib/wallhavened/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "wallhavened"
+  spec.version = Wallhavened::VERSION
+  spec.authors = ["Remigiusz Micielski"]
+  spec.email = ["rmicielski@purelymail.com"]
+  spec.summary = "Scrapes wallhaven"
+
+  # spec.description = "TODO: Write a longer description or delete this line."
+  # spec.homepage = "TODO: Put your gem's website or public repo "
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "wallhavaned", "~> 1.0"
+  spec.add_runtime_dependency "rake", "~> 13.0"
+  spec.add_runtime_dependency "minitest", "~> 5.16"
+  spec.add_runtime_dependency "open-uri"
+  spec.add_runtime_dependency "nokogiri"
+  spec.add_runtime_dependency "rdoc"
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "cli-ui"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: wallhavened
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Remigiusz Micielski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: open-uri
+  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: rdoc
+  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: thor
+  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: cli-ui
+  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:
+email:
+- rmicielski@purelymail.com
+executables:
+- wallhavened
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- exe/wallhavened
+- lib/wallhavened.rb
+- lib/wallhavened/version.rb
+- lib/wallhavened/wallhaven.rb
+- lib/wallhavened/wallhaven_wallpaper.rb
+- sig/wallhavened.rbs
+- wallhavened.gemspec
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Scrapes wallhaven
+test_files: []