KerbalStuff 0.1.5 → 0.1.6

data/.gitattributes

@@ -0,0 +1,22 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

data/.gitignore

@@ -0,0 +1,74 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# =========================
+# Operating System Files
+# =========================
+
+# OSX
+# =========================
+
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must ends with two \r.
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+# Windows
+# =========================
+
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp

data/KerbalStuff.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kerbalstuff/version"
+
+Gem::Specification.new do |s|
+	s.name		= 'KerbalStuff'
+	s.version	= KerbalStuff::VERSION
+	s.summary 	= "KerbalStuff"
+	s.description = "A simple API wrapper for KerbalStuff"
+	s.authors	= ["Alexandre Oliveira"]
+	s.email		= 'rockytvbr@gmail.com'
+	
+	s.files		= `git ls-files`.split("\n")
+	s.require_paths = ["lib"]
+	
+	s.homepage	=
+		'https://github.com/RockyTV/KerbalStuffGem'
+	s.license	= 'MIT'
+	s.extra_rdoc_files = ['README.md']
+	s.required_ruby_version = '>= 1.9.3'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) {{{year}}} {{{fullname}}}
+
+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/lib/KerbalStuff.rb

@@ -4,10 +4,11 @@ require 'uri'
 
 module KerbalStuff
 
-	api_url = "https://kerbalstuff.com/api"
-	user_url = "https://kerbalstuff.com/api/user/"
-	mod_url = "https://kerbalstuff.com/api/mod/"
-	
+	autoload :VERSION, 'kerbalstuff/version'
+	autoload :Mod, 'kerbalstuff/mod'
+	autoload :ModVerison, 'kerbalstuff/mod'
+	autoload :User, 'kerbalstuff/user'
+
 	def self.get_https_response(url)
 		@url = URI.parse(URI.escape(url))
 		http = Net::HTTP.new(@url.host, @url.port)
@@ -30,125 +31,78 @@ module KerbalStuff
 			else
 				return json
 			end
+		else
+			return json
 		end
 	end
 	
 	# Searches for mods with the specified keyword/phrase.
 	#
 	# @param query [String] the keyword/phrase to search for.
-	# @return [Hash] A parsed JSON output containing the mods which were found. Will return a [String] if no results were found.
+	# @return [Array] An array containing the results found. If no result was found, will return a String.
 	def self.search_mod(query)
 		res = get_json("https://kerbalstuff.com/api/search/mod?query=#{query}")
 		
+		resArr = []
+		
 		if res.length == 0
 			return "No results were found for '#{query}'."
 		else
-			return res
+			res.each do |mod|
+				resArr.push(Mod.new(mod))
+			end
+			return resArr
 		end
 	end
 	
 	# Searches for users with the specified keyword/phrase.
 	#
 	# @param query [String] the keyword/phrase to search for.
-	# @return [Hash] A parsed JSON output containing the users which were found. Will return a [String] if no results were found.
+	# @return [Array] An array containing the results found. If no result was found, will return a String.
 	def self.search_user(query)
 		res = get_json("https://kerbalstuff.com/api/search/user?query=#{query}")
 		
+		resArr = []
+		
 		if res.length == 0
 			return "No results were found for '#{query}'."
 		else
-			return res
-		end
-	end
-	
-	# Retrieves information about the specified user.
-	#
-	# @param username [String] the username to retrieve its information.
-	# @return [Hash] A parsed JSON output containing the information about the user. Will return a [String] if no users were found.
-	def self.user(username)
-		raise "username cannot be nil" unless username.length > 0
-		
-		res = get_json("https://kerbalstuff.com/api/user/#{username}")
-		
-		if res.include? 'error'
-			return res[1]
-		else
-			return res
-		end
-	end
-
-	# Retrieves the information about the specified mod.
-	#
-	# @param id [Fixnum] the id to retrieve its information.
-	# @return [Hash] A parsed JSON output containing the information about the mod. Will return a [String] if no mods were found.
-	def self.mod(id)
-		raise "id cannot be nil" unless id.is_a?(Integer)
-		
-		res = get_json("https://kerbalstuff.com/api/mod/#{id}")
-		
-		if res.include? 'error'
-			return res[1]
-		else
-			return res
+			res.each do |user|
+				resArr.push(User.new(user))
+			end
+			return resArr
 		end
 	end
 	
-	# Retrieves the information about the last released version of the specified mod.
+	# Retrieves the specified mod information.
 	#
-	# @param username [Fixnum] the id to retrieve information of its latest version released.
-	# @return [Hash] A parsed JSON output containing the information about the latest version released.
-	def self.get_latest_version(id)
-		raise "id cannot be nil" unless id.is_a?(Integer)
-		
-		res = get_json("https://kerbalstuff.com/api/mod/#{id}/latest")
+	# @param id [Integer] the id of the mod to retrieve information for.
+	# @return [Mod] A Mod object containing the information about the mod.
+	def self.get_mod(id)
+		raise "id must be an Integer" unless id.is_a?(Integer)
 		
-		if res.include? 'error'
-			return res[1]
-		else
-			return res
-		end
+		return Mod.new(get_json("https://kerbalstuff.com/api/mod/#{id}"))
 	end
 	
-	# Retrieves basic mod information - name, author, description, how many times it was downloaded, url to the mod and latest version.
+	# Retrieves the specified user information.
 	#
-	# @param id [Fixnum] The id of the mod to retrieve information for.
-	# @return [Hash] A hash containing basic mod info.
-	def self.get_basic_mod_info(id)
-		oldHash = mod(id)
+	# @param username [String] the username of the user to retrieve information for.
+	# @return [User] A User object containing the information about the user.
+	def self.get_user(username)
+		raise "username must be a String" unless username.is_a?(String)
+		raise "username cannot be an empty string" unless username.length > 0
 		
-		if oldHash.is_a?(String)
-			return oldHash
-		else
-			modHash = Hash.new()
-			modHash["name"] = oldHash["name"]
-			modHash["author"] = oldHash["author"]
-			modHash["description"] = oldHash["short_description"]
-			modHash["downloads"] = oldHash["downloads"]
-			modHash["url"] = "https://kerbalstuff.com/mod/#{id}/}"
-			modHash["latest_version"] = oldHash["versions"][0]["friendly_version"]
-			
-			return modHash
-		end
+		return User.new(get_json("https://kerbalstuff.com/api/user/#{username}"))
 	end
 	
-	# Retrieves basic user info - username, mods, irc nick and forum username.
+	# Retrieves the latest version of the specified mod.
 	#
-	# @param username [String] The user to gather information for.
-	# @return [Hash] A hash containing the basic user info.
-	def self.get_basic_user_info(username)
-		oldHash = user(username)
+	# @param id [Integer] the id of the mod to retrieve the latest version released.
+	# @return [ModVersion] A ModVersion object containing information about the version.
+	def self.get_latest_mod_version(id)
+		raise "id must be an Integer" unless id.is_a?(Integer)
 		
-		if oldHash.is_a?(String)
-			return oldHash
-		else
-			userHash = Hash.new()
-			userHash["username"] = oldHash["username"]
-			userHash["mods"] = oldHash["mods"]
-			userHash["ircNick"] = oldHash["ircNick"]
-			userHash["forumusername"] = oldHash["forumusername"]
-		
-			return userHash
-		end
+		return ModVersion.new(get_json("https://kerbalstuff.com/api/mod/#{id}/latest"))
 	end
 	
 end

data/lib/kerbalstuff/mod.rb

@@ -0,0 +1,54 @@
+module KerbalStuff
+	class Mod
+		
+		attr_reader :json
+		
+		def initialize json
+			@json = json
+			
+			@name = @json['name']
+			@background = @json['background']
+			@author = @json['author']
+			@downloads = @json['downloads']
+			@id = @json['id']
+			@short_description = @json['short_description']
+			@description_html = @json['description_html']
+			@followers = @json['followers']
+			@default_version_id = @json['default_version_id']
+			@description = @json['description']
+			
+			if @json.has_key?('versions')
+				@versions = []
+				if @json['versions'].length > 0
+					@json['versions'].each do |v|
+						@versions.push(ModVersion.new(v))
+					end
+				end
+			end
+			
+		end
+		
+		def to_s
+			"Mod:\nname=#{@name}\nbackground=#{@background}\nauthor=#{@author}\ndownloads=#{@downloads}\nid=#{@id}\nshort_description=\"#{@short_description}\"\nversions=#{@versions}\ndescription_html=\"#{@description_html}\"\nfollowers=#{@followers}\ndefault_version_id=#{@default_version_id}\ndescription=\"#{@description}\"\n"
+		end
+	end
+	
+	class ModVersion
+	
+		attr_reader :json
+		
+		def initialize json
+			@json = json
+			
+			@version = @json['friendly_version']
+			@download_path = @json['download_path']
+			@id = @json['id']
+			@ksp_version = @json['ksp_version']
+			@changelog = @json['changelog']
+		end
+		
+		def to_s
+			"ModVersion:\nversion=#{@version}, download=#{@download_path}, id=#{@id}, ksp_version=#{@ksp_version}, changelog=\"#{@changelog}\"\n"
+		end
+	end
+end

data/lib/kerbalstuff/user.rb

@@ -0,0 +1,29 @@
+module KerbalStuff
+	class User
+		
+		attr_reader :json
+		
+		def initialize json
+			@json = json
+			
+			@ircNick = @json['ircNick']
+			@mods = []
+			@twitterUsername = @json['twitterUsername']
+			@username = @json['username']
+			@redditUsername = @json['redditUsername']
+			@forumUsername = @json['forumUsername']
+			@description = @json['description']
+			
+			if @json['mods'].length > 0
+				@json['mods'].each do |mod|
+					@mods.push(Mod.new(mod))
+				end
+			end
+		end
+		
+		def to_s
+			"User:\nircNick=#{@ircNick}\nmods=#{@mods}\ntwitterUsername=#{@twitterUsername}\nusername=#{@username}\nredditUsername=#{@redditUsername}\nforumUsername=#{@forumUsername}\ndescription=\"#{@description}\"\n"
+		end
+		
+	end
+end

data/lib/kerbalstuff/version.rb

@@ -0,0 +1,3 @@
+module KerbalStuff
+	VERSION = "0.1.6"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: KerbalStuff
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-25 00:00:00.000000000 Z
+date: 2014-09-29 00:00:00.000000000 Z
 dependencies: []
 description: A simple API wrapper for KerbalStuff
 email: rockytvbr@gmail.com
@@ -18,8 +18,15 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- lib/KerbalStuff.rb
+- .gitattributes
+- .gitignore
+- KerbalStuff.gemspec
+- LICENSE.txt
 - README.md
+- lib/KerbalStuff.rb
+- lib/kerbalstuff/mod.rb
+- lib/kerbalstuff/user.rb
+- lib/kerbalstuff/version.rb
 homepage: https://github.com/RockyTV/KerbalStuffGem
 licenses:
 - MIT