libgen_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44501aa543f10a08cf2824a7874d7aa58afd2c4bcdc0443179e1a099de8ec9e8
+  data.tar.gz: 4d24e8293a18129b95976c4ea6acdb73ef502bcf2329d29ff3d50f1ba0287afd
+SHA512:
+  metadata.gz: da763aedbf5abdc50ae6488396a9c69704729f745cd7091d031826cdadaf08efaf4a4cd711c7bcc283d3a7b0296db6e1e9e4a2e1680f6ebaeb8a7266f7e163e9
+  data.tar.gz: baea8a346012e5db6e399fb00abec2ed89fb557506e36cbb7dbdbaeac065e4b857f1a42c74cec3935dc90ae75e3b3773ee563988f73f1256474b281ef0623b60

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.DS_Store

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {"https://github.com/Sag0Sag0/libgen_api"}
+
+# Specify your gem's dependencies in libgen_api.gemspec
+gemspec
+
+gem 'httparty'
+gem 'nokogiri'
+gem "minitest"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Sag0Sag0
+
+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,91 @@
+# LibgenApi
+
+Welcome to the `libgen_api` gem!
+
+This gem allows you to search library genesis easily and relatively quicky.
+
+## Advice
+
+The Library Genesis maintainers run the library for free through donations. 
+Please don't overload their servers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'libgen_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install libgen_api
+
+## Usage
+### Searching the site
+The main search method is called `search()` and has three options.
+
+The first is `query` and is set to the value of the search you want to make.
+The second is `res` and is set to the amount of results you want to recieve per page. The values you can give here are 10, 25 or 100.
+The final option is `column` and is which column you want to search. The values this can have are `def`(if unsure use this one), `title`, `author`, `series`, `publisher`, `year`, `identifier`, `language`, `md5`, `tags` and `extension`.
+
+This method will return in order the id's of the books shown in your search results.
+
+### Retrieving books
+Books can be retrieved using their ids.
+
+The method `get_book()` can be used to retrieve an individual books information where as the method `get_books()` can be used to retrieve multiple books.
+`get_book()` has two parameters, `id` and `fields`. `id` is any books id number whilst `fields` contains an array of which fields you are interested in looking at. A list of fields can be found [here](http://garbage.world/posts/libgen/). By default the `title`, `author` and `md5` fields are requested. It returns a hash with each selected field being a key that can be used to access its value.
+
+`get_books()` works basically the same excepts its first argument is `ids` which accepts an array of ids. It returns an array of hashes for each book requested.
+
+Both methods only make one http request, so don't be shy about requesting multiple books at once.
+
+### Changing site
+By default requests go to `libgen.is`. To change this call the method `change_mirror()` with the string of the new mirror site. 
+To check what mirror is currently being used call `get_mirror()`
+
+### Example
+```ruby
+require 'libgen_api'
+
+# Change the mirror, this is not necessary.
+LibgenApi.change_mirror("gen.lib.rus.ec")
+
+# Search for books using the search term "dodo" with results per page 100 and default column settings.
+# This is the potentially time consuming part, each page needs to be downloaded and parsed. 
+# If your search term has a lot of results this can take a while.
+ids = LibgenApi.search("dodo", 100, "def")
+
+# Now we grab the books information, specifically their title and author/s.
+# This is quick, it only takes one request from the JSON api.
+books = LibgenApi.get_books(ids, ["title", "author"])
+
+# Now print their title and author/s! 
+books.each do |book|
+    puts "Title: #{book['title']}\nAuthor: #{book['author']}\n\n"
+end
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, 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/Sag0Sag0/libgen_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Thanks
+
+I'd like to thank the creators of [libgen.js](https://github.com/dunn/libgen.js/) and the author of [this](http://garbage.world/posts/libgen/) and of course the creators and maintainters of Library Genesis. They were all very helpfull in creating this gem.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "libgen_api"
+
+# 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/lib/libgen_api.rb

@@ -0,0 +1,101 @@
+require "libgen_api/version"
+
+require "json"
+
+require 'httparty'
+require 'nokogiri'
+
+module LibgenApi
+    class Error < StandardError; end
+
+    @mirror = 'libgen.is'
+
+    # Results are in the same order as search results.
+    def self.get_ids(page)
+        books = []
+
+        table = page.search('table')[2]
+        table.search('tbody').each do |tb|
+            tb.search('tr').each do |tr|
+
+                # Here we check to see if the name of th current text element is "ID:"
+                # and then move onto to the next element in the loop which contains the id.
+                found_id = false
+                tr.search('td').each do |td|
+                    if found_id
+                        books.push(td.text)
+                        break
+                    end
+
+                    if td.text == "ID:"
+                        found_id = true
+                    end
+                end
+            end
+        end
+
+        books
+    end
+
+    def self.get_mirror
+        @mirror
+    end
+
+    def self.change_mirror(new_mirror)
+        @mirror = new_mirror
+    end
+
+    def self.search(query, res, column)
+        raise "query must be at least four characters long!" if query.length() < 4
+
+        if res != 25 && res != 50 && res != 100
+            raise "res must equal either 25, 50 or 100"
+        end
+        
+        id_collection = []
+        page = 1
+        loop do
+            url = "http://#{@mirror}/search.php?req=#{query}&lg_topic=libgen&open=0&view=detailed&res=#{res}&column=#{column}&page=#{page}"
+            response = HTTParty.get(url)
+
+            doc = Nokogiri::HTML(response.body)
+            page_ids = get_ids(doc)
+
+            id_collection = id_collection + page_ids
+
+            if page_ids.length() != res
+                break
+            end
+
+            page += 1
+        end
+
+        id_collection
+    end
+
+    def self.get_book(id, fields=["Title", "Author", "MD5"])
+        fields = fields.join(',')
+
+        res = HTTParty.get("http://#{@mirror}/json.php?ids=#{id}&fields=#{fields}")
+
+        begin
+            JSON.parse(res.body)[0]
+        rescue JSON::ParserError, TypeError => e
+            raise "An error has occured when parsing the JSON recieved. The error is:\n#{e}"
+        end
+    end
+
+    def self.get_books(ids, fields=["Title", "Author", "MD5"])
+        ids = ids.map(&:to_s).join(',')
+        fields = fields.join(',')
+
+        res = HTTParty.get("http://#{@mirror}/json.php?ids=#{ids}&fields=#{fields}")
+
+        begin
+            JSON.parse(res.body)
+        rescue JSON::ParserError, TypeError => e
+            raise "An error has occured when parsing the JSON recieved. The error is:\n#{e}"
+        end
+    end
+
+end

data/lib/libgen_api/version.rb

@@ -0,0 +1,3 @@
+module LibgenApi
+  VERSION = "0.1.1"
+end

data/libgen_api.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "libgen_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "libgen_api"
+  spec.version       = LibgenApi::VERSION
+  spec.authors       = ["Sag0Sag0"]
+  spec.email         = ["Sag0Sag0@outlook.com"]
+
+  spec.summary       = "An API that can be used to search Library Genesis"
+  spec.description   = "An API that can be used to search Library Genesis. In the early stages."
+  spec.homepage      = "https://github.com/Sag0Sag0/libgen_api"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) 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_dependency "httparty"
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.3"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: libgen_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sag0Sag0
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-28 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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: 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: 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: An API that can be used to search Library Genesis. In the early stages.
+email:
+- Sag0Sag0@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/libgen_api.rb
+- lib/libgen_api/version.rb
+- libgen_api.gemspec
+homepage: https://github.com/Sag0Sag0/libgen_api
+licenses:
+- MIT
+metadata: {}
+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: An API that can be used to search Library Genesis
+test_files: []