chanCrawlerGem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dbabf298d0219b42b41b9e55921258622b7480962006f4afde7688597fffccaf
+  data.tar.gz: 85fb16eb26bb05c83cca31fb453115a2cb24375a80e9ac8e4419625c33f7ca7e
+SHA512:
+  metadata.gz: 7727b8c55f2ad5a38c3efb847762b033e7b8cf49c4cd20b021c5f088daf30ba7d86fbbbd26fdbad007fa4f9a6c442f69f09e573bf722b9e2e40a7238dd58fcdd
+  data.tar.gz: 8327e4c58555768cdc2a320766a889e6e3a8c4ea101da97352e480fbb67a3b45939d230acc782d4bb7f0bb2c728f9b9c203a4c0bf7051a34246a502528a0aaf4

data/.env_template

@@ -0,0 +1,4 @@
+BASE_URL='http://boards.4chan.org/' # This is the value that you should set for 4chan.org, you can try to set another chan board, haven't tried that yet tho
+BOARDS='g,sci' # You need to list the board in which you want to search for content as they are here, delimited by commas without space
+DEST_FOLDER='/path/to/some_folder/here/' # This is the path to a folder where you want the content to be downloaded to
+KEY_WORDS='graphs,wow,doge' # Here you should list the words that should be contained in the thread title. If a thread contains the word, all the contents will be downloaded

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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.3

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 iulia@stessa.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,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in chanCrawlerGem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Iulia Chtian
+
+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,52 @@
+# ChanCrawlerGem
+
+This gem scowers 4chan (or any chan copy theoretically) searching for threads that
+contains key words specified by you on boards specified by you and downloads
+all the images, gifs and webms to a specified folder
+
+## Installation
+
+
+```ruby
+gem 'chanCrawlerGem'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chanCrawlerGem
+
+## Usage
+
+Set up a .env following the pattern described in the .env_template and then run ChanCrawlerGem.give_me_the_documents
+as shown in the example.rb file. In facut, simply running the example.rb file after creating the .env will work just fine
+
+So just to be clear here's a step by step:
+### Step 1 Create .env file
+
+For this step use the .env_template provided and fill in the desired values
+
+### Step 2 Create a downloads directory
+
+Create the directory and put it's path in the DEST_FOLDER variable
+
+### Step 3 Create the script
+
+Create a simple script that requires the gem and runs the "give_me_the_documents" method like so
+
+```ruby
+require 'chanCrawlerGem'
+
+ChanCrawlerGem.give_me_the_documents
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ChanCrawlerGem project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chanCrawlerGem/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'chanCrawlerGem'
+
+# 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/chanCrawlerGem.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chanCrawlerGem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chanCrawlerGem'
+  spec.version       = ChanCrawlerGem::VERSION
+  spec.authors       = ['Lithiil']
+  spec.email         = ['tudorjamal@gmail.com']
+
+  spec.summary       = 'Test'
+  spec.description   = 'test'
+  spec.homepage      = 'https://github.com/chanCrawler'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/chanCrawler'
+    spec.metadata['changelog_uri'] = 'https://github.com/chanCrawler'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'down'
+  spec.add_development_dependency 'fileutils'
+  spec.add_development_dependency 'httparty'
+  spec.add_development_dependency 'json'
+  spec.add_development_dependency 'nokogiri'
+  spec.add_development_dependency 'open-uri'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/example.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'chanCrawlerGem'
+
+ChanCrawlerGem.give_me_the_documents

data/lib/chanCrawlerGem.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'chanCrawlerGem/version'
+require 'dotenv/load'
+require 'httparty'
+require 'pry'
+require 'nokogiri'
+require 'open-uri'
+require 'down'
+require 'fileutils'
+
+module ChanCrawlerGem
+  class Error < StandardError; end
+  Dotenv.require_keys('BASE_URL', 'BOARDS', 'DEST_FOLDER', 'KEY_WORDS')
+
+  class Collector
+    attr_reader :boards, :key_words, :relevant_links
+
+    def initialize(boards, key_words)
+      @relevant_links = []
+      @boards = boards
+      @@base_url = ENV['BASE_URL']
+      @key_words = key_words
+    end
+
+    def board_catalog_urls
+      # puts 'Getting catalogs'
+      catalogs = {}
+      boards.each { |board| catalogs[board] = "http://a.4cdn.org/#{board}/catalog.json" }
+      catalogs
+    end
+
+    def thread_relevant?(thread)
+      return false if thread['com'].nil?
+
+      # puts "Checking thread relevancy for #{thread['com']}"
+      @key_words.each do |word|
+        return false unless thread['com']
+                            .downcase
+                            .include?(word.downcase) && thread['images']
+                            .positive?
+      end
+    end
+
+    def analyze_threads(threads, board)
+      # puts 'Analyzing thread list'
+      threads.each do |thread|
+        if thread_relevant?(thread)
+          relevant_links.push "#{@@base_url}#{board}/thread/#{thread['no']}"
+        end
+      end
+    end
+
+    def get_relevant_threads
+      # puts 'Retrieving relevant threads'
+      catalogs = board_catalog_urls
+      catalogs.each do |board, catalog|
+        catalog_content = JSON.parse(HTTParty.get(catalog).body)
+        next if catalog_content.count < 1
+
+        catalog_content.each do |page|
+          next unless page['threads'].count.positive?
+
+          analyze_threads(page['threads'], board)
+        end
+      end
+      # puts 'Relevant threads retrieved'
+    end
+  end
+
+  class DownloadManager
+    attr_reader :download_dest
+
+    def initialize(download_destination)
+      @download_dest = download_destination
+    end
+
+    def get_thread_contents(thread)
+      # puts "Parsing #{thread} for content"
+      document = Nokogiri::HTML(URI.open(thread))
+      results = document.css('.board .fileThumb')
+      result_links = results.map { |t| t[:href] }
+    end
+
+    def download_thread_contents(urls)
+      urls.each do |url|
+        download(url) if already_present?(url) == false
+      end
+    end
+
+    def download(resource_url)
+      puts "Downloading #{resource_url}"
+      tmpfile = Down.download("http:#{resource_url}")
+      FileUtils.mv(tmpfile.path, "#{download_dest}#{tmpfile
+                                                      .original_filename}")
+      puts 'Downloaded successfully'
+    end
+
+    def already_present?(item_name)
+      name = item_name.slice(15, item_name.length)
+      false unless File.file?("#{download_dest}/#{name}")
+    end
+  end
+
+  def self.give_me_the_documents
+    collector = ChanCrawlerGem::Collector.new(ENV['BOARDS'].split(','),
+                                              ENV['KEY_WORDS'].split(','))
+    collector.get_relevant_threads
+    downloader = ChanCrawlerGem::DownloadManager.new(ENV['DEST_FOLDER'])
+    collector.relevant_links.each do |thread|
+      downloader.download_thread_contents(downloader
+                                            .get_thread_contents(thread))
+    end
+  end
+end

data/lib/chanCrawlerGem/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ChanCrawlerGem
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: chanCrawlerGem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lithiil
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: down
+  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: fileutils
+  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: httparty
+  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: json
+  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: nokogiri
+  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: open-uri
+  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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: test
+email:
+- tudorjamal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env_template"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chanCrawlerGem.gemspec
+- example.rb
+- lib/chanCrawlerGem.rb
+- lib/chanCrawlerGem/version.rb
+homepage: https://github.com/chanCrawler
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/chanCrawler
+  source_code_uri: https://github.com/chanCrawler
+  changelog_uri: https://github.com/chanCrawler
+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.6
+signing_key: 
+specification_version: 4
+summary: Test
+test_files: []