ncbi-blast-dbs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4548901d7963958b9ee98e4a45b558d1654f6151
+  data.tar.gz: 79d2503e82646c94aa04ff30f0b25e99646e0f55
+SHA512:
+  metadata.gz: 5ecb01abb31c1b41e6301a4dcda923a27c44b4175ce06f00293795dd801a2247eb3ba6d760e3ee0457f9b41b207251b8b251b216db9789b6ebba8c24f107cbfe
+  data.tar.gz: 33d2aee65c3baf1fce7adf020e1efd40ed927fa7898cff14bc4de104c080091f7520149d614ece5ff6976f3704e9dc920eec59b9d8c50fb93072747d636540c6

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Anurag Priyam
+
+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,30 @@
+## Fast download BLAST databases from NCBI
+
+Database files (volumes) are downloaded in parallel: number of threads to use
+is determined automatically. MD5 checksum is verified and the database files
+extracted upon download. Database volumes are not downloaded in a particular
+order. Downloads are incremental, that is it will only download new data,
+provided the `.tar.gz` files have not been deleted.
+
+It is faster than NCBI's `update_blastdb.pl`. But unlike `update_blastdb.pl`,
+which is a pure Perl script, it delegates download and checksum verification
+to `wget` and `md5sum` and is thus not as universal.
+
+### Installation
+
+    gem install ncbi-blast-dbs
+
+### Usage
+
+#### List available BLAST databases
+
+    ncbi-blast-dbs
+
+#### Download all volumes of a BLAST database
+
+    ncbi-blast-dbs nr
+
+NCBI expects users to submit their email address when downloading data from
+their FTP server. To comply with that, download as:
+
+    email="my email address here" ncbi-blast-dbs nr

data/bin/ncbi-blast-dbs

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rake'
+import "#{__dir__}/../lib/ncbi-blast-dbs.rake"
+app = Rake.application; app.init; app.load_imports; app.top_level

data/lib/ncbi-blast-dbs.rake

@@ -0,0 +1,28 @@
+require 'net/ftp'
+
+def download(url)
+  file = File.basename(url)
+  sh "wget -Nc #{url} && wget -Nc #{url}.md5 &&"\
+     " md5sum -c #{file}.md5 && tar xvf #{file}"
+end
+
+def databases
+  host, dir = 'ftp.ncbi.nlm.nih.gov', 'blast/db'
+  usr, pswd = 'anonymous', ENV['email']
+
+  Net::FTP.open(host, usr, pswd) do |con|
+    con.passive = true
+    con.nlst(dir).
+      map { |file| File.join(host, file) }.
+      select { |file| file.match(/\.tar\.gz$/) }.
+      group_by { |file| File.basename(file).split('.')[0] }
+  end
+end
+
+databases.each do |name, files|
+  multitask(name => files.map { |file| task(file) { download(file) } })
+end
+
+task :default do
+  puts databases.keys.join(', ')
+end

data/ncbi-blast-dbs.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.authors     = ['Anurag Priyam']
+  s.email       = ['anurag08priyam@gmail.com']
+  s.name        = 'ncbi-blast-dbs'
+  s.version     = '0.0.1'
+  s.summary     = 'Fast download BLAST databases from NCBI.'
+  s.description = <<DESC
+Downloads BLAST databases from NCBI. Database files (volumes) are downloaded in
+parallel; number of threads to use is determined automatically.  Database files
+are verified and extracted upon download.
+DESC
+  s.license     = 'MIT'
+  s.homepage    = 'http://github.com/yeban/ncbi-blast-dbs'
+
+  s.files         = `git ls-files`.split
+  s.require_paths = ['lib']
+  s.add_dependency('rake', '~> 10.3', '>= 10.3.2')
+  s.executables   = ['ncbi-blast-dbs']
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: ncbi-blast-dbs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anurag Priyam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+description: |
+  Downloads BLAST databases from NCBI. Database files (volumes) are downloaded in
+  parallel; number of threads to use is determined automatically.  Database files
+  are verified and extracted upon download.
+email:
+- anurag08priyam@gmail.com
+executables:
+- ncbi-blast-dbs
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/ncbi-blast-dbs
+- lib/ncbi-blast-dbs.rake
+- ncbi-blast-dbs.gemspec
+homepage: http://github.com/yeban/ncbi-blast-dbs
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Fast download BLAST databases from NCBI.
+test_files: []
+has_rdoc: