strike_api 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d65c3d617a9e1b60ef55e43e18c632b27aeebe9
-  data.tar.gz: c3d400eac4086e10ca10b7b54bda254fc8da84d5
+  metadata.gz: cfe5f4a17f2aaf0d99b6696601d1b2a563920692
+  data.tar.gz: 3f2534d86c091777a31c03d4f38aced81ca29adf
 SHA512:
-  metadata.gz: f8deea23f0301bba66030b33ead8db225b5d28883566d4990893061aaf7e74becdcde975dbce2db37c22499f649d9177c3c3bf549dd548cb583529260aeace7d
-  data.tar.gz: 330163ad930bc5a8338f335d8ecdae7ccda51e07de234dd75b5874c75d597abbea7883b05134ca7a823c1dbb26beeaea642acc166afd421dc90b7cca76a1f960
+  metadata.gz: 6c5f3779ea342bbb198979becea5c796747ca816c7581e154d2b196381440ff9754acf489fee78c6d6305e927406bdc835cfdd0a8f35294a83388ae8c11637b1
+  data.tar.gz: 0b99a3ddf1c18a7ac2c5b329423a36ca8ef41c50f963409c45e7eb8df92c6ddfa8d454c83bcf20b67f376fb57468b40a2d083cc2d62851cf386643ecc6da30ac

data/README.md

@@ -1,6 +1,8 @@
 # Strike API
 
-API wrapper for the Strike Search website (http://getstrike.net)
+[![Gem Version](https://img.shields.io/gem/v/strike_api.svg)](https://rubygems.org/gems/strike_api)
+
+API wrapper for the Strike Search website (https://getstrike.net/torrents/)
 
 ## Installation
 
@@ -20,12 +22,61 @@ Or install it yourself as:
 
 ## Usage
 
-See tests for usage examples.
+### Find
+
+* Param 1: torrent hash string, array of torrent hash strings
+* Returns: array of torrent objects (objects include file_info data)
+
+```
+result = StrikeApi::Torrent.find(yourTorrentHash)
+```
+
+### Search
+
+* Param 1: search phrase, example: "ubuntu iso"
+* Returns: array of torrent objects
+
+```
+result = StrikeApi::Torrent.search(yourSearchPhrase)
+```
+
+* Param 1: search phrase, example: "ubuntu iso"
+* Param 2: Category or sub category, examples: "Music", "Documentary"
+* Returns: array of torrent objects
+
+```
+result = StrikeApi::Torrent.search(yourSearchPhrase, yourCatagoryOrSubCategory)
+```
+
+* Param 1: search phrase, example: "ubuntu iso"
+* Param 2: Category, example: "Applications"
+* Param 3: Sub category, example: "Windows"
+* Returns: array of torrent objects
+
+```
+result = StrikeApi::Torrent.search(yourSearchPhrase, yourCatagory, yourSubCategory)
+```
+
+### Categories and sub categories
+
+* Returns: array of valid categories
+
+```
+result = StrikeApi::Torrent.catagoriesAvailable()
+```
+
+* Returns: array of valid sub categories
+
+```
+result = StrikeApi::Torrent.subCatagoriesAvailable()
+```
+
+See tests for more usage examples.
 
 ## TODO
 
 1. Better commenting
-2. Provide usage examples in readme
+2. ~~Provide usage examples in readme~~
 
 ## Contributing
 

data/lib/strike_api/torrent.rb

@@ -6,7 +6,7 @@ API_URL = "https://getstrike.net/api/v2/torrents"
 
 module StrikeApi
 	class Torrent
-		attr_reader :hash, :title, :category, :sub_category, :seeds, :leeches, :file_count, :size, :download_count, :upload_date, :uploader_username, :magnet_uri
+		attr_reader :hash, :title, :category, :sub_category, :seeds, :leeches, :file_count, :size, :download_count, :upload_date, :uploader_username, :magnet_uri, :file_info
 
 		# Constructor for torrent objects
 	    def initialize(attributes)
@@ -22,6 +22,14 @@ module StrikeApi
 		    @upload_date = attributes["upload_date"]
 		    @uploader_username = attributes["uploader_username"]
 		    @magnet_uri = attributes["magnet_uri"]
+		    if(attributes.has_key?("file_info")) # file info is only included in hash searches (the find method)
+		    	file_names = attributes["file_info"]["file_names"].to_a
+		    	file_lengths = attributes["file_info"]["file_lengths"].to_a
+		    	@file_info = Array.new
+		    	file_names.each_with_index do |item, i|
+		    		@file_info[i] = [file_names[i],file_lengths[i]]
+		    	end
+		    end
 		end
 
 		# Allows for both a single torrentHash via a string and multiple via an array of torrentHash strings.
@@ -29,8 +37,11 @@ module StrikeApi
 	  	def self.find(torrentHash)
   			hashListStr = ""
   			torrentHash = Array(torrentHash)
+  			if(torrentHash.length > 50)
+  				raise "Strike API accepts a maximum of 50 hashes per query"
+  			end
   			torrentHash.length.times do |i|
-  				hashListStr = hashListStr + torrentHash[i] + ","
+  				hashListStr += torrentHash[i] + ","
   			end
 			response =  HTTParty.get("#{API_URL}/info/?hashes=#{hashListStr}")
 			errorChecker(response)

data/lib/strike_api/version.rb

@@ -1,3 +1,3 @@
 module StrikeApi
-	VERSION = "1.0.2"
+	VERSION = "1.0.3"
 end

data/strike_api.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
 	spec.authors       = ["Marshall Ford","Brett Chastain"]
 	spec.email         = ["inbox@marshallford.me"]
 	spec.summary       = %q{Wrapper for the Strike API.}
-	spec.description   = %q{API wrapper for the Strike Search website (http://getstrike.net)}
+	spec.description   = %q{API wrapper for the Strike Search website (https://getstrike.net/torrents/)}
 	spec.homepage      = "https://github.com/marshallford/strike_api"
 	spec.license       = "MIT"
 

data/test/torrent/torrent_test.rb

@@ -22,6 +22,8 @@ class StrikeTorrentTest < Minitest::Test
 			assert_equal "Feb 24, 2014", result.upload_date
 			assert_equal "Nusantara", result.uploader_username
 			assert_equal "magnet:?xt=urn:btih:156B69B8643BD11849A5D8F2122E13FBB61BD041&dn=Slackware+14.1+x86_64+DVD+ISO&tr=udp:\/\/open.demonii.com:1337&tr=udp:\/\/tracker.coppersurfer.tk:6969&tr=udp:\/\/tracker.leechers-paradise.org:6969&tr=udp:\/\/exodus.desync.com:6969", result.magnet_uri
+			assert_equal "slackware64-14.1-iso\\slackware64-14.1-install-dvd.iso", result.file_info[0][0] # first file, filename
+			assert_equal 2438987776, result.file_info[0][1] # first file, file length
 	    end
 	end
 
@@ -44,6 +46,8 @@ class StrikeTorrentTest < Minitest::Test
 			assert_equal "Feb 24, 2014", result1.upload_date
 			assert_equal "Nusantara", result1.uploader_username
 			assert_equal "magnet:?xt=urn:btih:156B69B8643BD11849A5D8F2122E13FBB61BD041&dn=Slackware+14.1+x86_64+DVD+ISO&tr=udp:\/\/open.demonii.com:1337&tr=udp:\/\/tracker.coppersurfer.tk:6969&tr=udp:\/\/tracker.leechers-paradise.org:6969&tr=udp:\/\/exodus.desync.com:6969", result1.magnet_uri
+			assert_equal "slackware64-14.1-iso\\slackware64-14.1-install-dvd.iso", result1.file_info[0][0] # first file, filename
+			assert_equal 2438987776, result1.file_info[0][1] # first file, file length
 			# Torrent 2: Arch ISO
 			assert_equal StrikeApi::Torrent, result2.class
 			assert_equal "B425907E5755031BDA4A8D1B6DCCACA97DA14C04", result2.hash
@@ -58,6 +62,8 @@ class StrikeTorrentTest < Minitest::Test
 			assert_equal "Jan  6, 2015", result2.upload_date
 			assert_equal "The_Doctor-", result2.uploader_username
 			assert_equal "magnet:?xt=urn:btih:B425907E5755031BDA4A8D1B6DCCACA97DA14C04&dn=Arch+Linux+2015.01.01+%28x86%2Fx64%29&tr=udp:\/\/open.demonii.com:1337&tr=udp:\/\/tracker.coppersurfer.tk:6969&tr=udp:\/\/tracker.leechers-paradise.org:6969&tr=udp:\/\/exodus.desync.com:6969", result2.magnet_uri
+	    	assert_equal "archlinux-2015.01.01-dual.iso", result2.file_info[0][0] # first file, filename
+			assert_equal 615514112, result2.file_info[0][1] # first file, file length
 	    end
 	end
 
@@ -107,6 +113,7 @@ class StrikeTorrentTest < Minitest::Test
 	      	assert_equal 1, result.length
 	      	assert result.kind_of?(Array)
 	      	assert result.first.kind_of?(StrikeApi::Torrent)
+	      	assert !result[0].file_info # file_info information is not given in search results
 	    end
   	end
 
@@ -116,6 +123,7 @@ class StrikeTorrentTest < Minitest::Test
 	      	assert_equal 100, result.length
 	      	assert result.kind_of?(Array)
 	      	assert result.first.kind_of?(StrikeApi::Torrent)
+	      	assert !result[0].file_info # file_info information is not given in search results
 	    end
   	end
 
@@ -125,6 +133,7 @@ class StrikeTorrentTest < Minitest::Test
 	      	assert_equal 100, result.length
 	      	assert result.kind_of?(Array)
 	      	assert result.first.kind_of?(StrikeApi::Torrent)
+	      	assert !result[0].file_info # file_info information is not given in search results
 	    end
   	end
 
@@ -134,6 +143,7 @@ class StrikeTorrentTest < Minitest::Test
 	      	assert_equal 100, result.length
 	      	assert result.kind_of?(Array)
 	      	assert result.first.kind_of?(StrikeApi::Torrent)
+	      	assert !result[0].file_info # file_info information is not given in search results
 	    end
   	end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strike_api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Marshall Ford
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-12 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: API wrapper for the Strike Search website (http://getstrike.net)
+description: API wrapper for the Strike Search website (https://getstrike.net/torrents/)
 email:
 - inbox@marshallford.me
 executables: []