KerbalStuff 0.2.0 → 0.2.1

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+0.2.1 (November 20, 2014)
+* Added support for **POST** methods (Login, CreateMod, UpdateMod)
+* All methods now return an array containing the info you need. Example: `["name=test", "id=1337"]`
+
+
+
+0.2.0 (October 25, 2014)
+* Added support for KerbalStuff **browse** methods
+* Added links to Mod.background and ModVersion.download_path

data/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+If you want to help, here's what you need to do:
+
+* Fork the repository
+* Change/Add what you want
+* Submit a pull request 
+
+I'll personally review the request you've made and, if it is good enough, I'll merge it with the master branch.
+
+
+### Warning
+
+Please don't add more dependencies than what this gem already has. If you are going to add a dependency, please create an issue, with the title as:
+`[DEPENDENCY] rubygems`
+
+And then you'll state why you want to add a dependency.

data/KerbalStuff.gemspec

@@ -5,7 +5,7 @@ require "kerbalstuff/version"
 Gem::Specification.new do |s|
 	s.name		= 'KerbalStuff'
 	s.version	= KerbalStuff::VERSION
-	s.summary 	= "KerbalStuff"
+	s.summary 	= "KerbalStuff's Ruby API Wrapper"
 	s.description = "A simple API wrapper for KerbalStuff"
 	s.authors	= ["Alexandre Oliveira"]
 	s.email		= 'rockytvbr@gmail.com'

data/README.md

@@ -59,5 +59,4 @@ licensed under MIT License Copyright (c) 2014 Alexandre Oliveira. See LICENSE fo
 
 ## Contributing
 
-If you want to contribute, feel free to do so! 
-Just fork the repo, make your changes, and then submit the pull-request.
+See [CONTRIBUTING.MD](http://github.com/RockyTV/KerbalStuffGem/CONTRIBUTING.MD)

data/lib/KerbalStuff.rb

@@ -1,4 +1,5 @@
 require 'net/http'
+require 'net/http/post/multipart'
 require 'json'
 require 'uri'
 
@@ -8,6 +9,7 @@ module KerbalStuff
 	autoload :Mod, 'kerbalstuff/mod'
 	autoload :ModVerison, 'kerbalstuff/mod'
 	autoload :User, 'kerbalstuff/user'
+	autoload :Auth, 'kerbalstuff/auth'
 
 	def self.get_https_response(url)
 		@url = URI.parse(URI.escape(url))

data/lib/kerbalstuff/auth.rb

@@ -0,0 +1,136 @@
+module KerbalStuff
+
+	class NotLoggedInException < Exception
+	end
+	
+	class LoginException < Exception
+	end
+	
+	class ErrorException < Exception
+	end
+
+	class Auth
+	
+		attr_accessor :cookie
+	
+		# Logs into Kerbal Stuff.
+		#
+		# @param username [String]
+		# @param password [String]
+		# @return [Array] An array with the status of the login.	
+		def self.login(params = {})
+			@username = params['username']
+			@password = params['password']
+			
+			url = URI.parse("https://kerbalstuff.com/api/login")
+			
+			http = Net::HTTP.new(url.host, url.port)
+			http.use_ssl = true
+			http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+			
+			req = Net::HTTP::Post::Multipart.new url.path, "username" => @username, "password" => @password
+			
+			res = http.start do |http2|
+				http2.request(req)
+			end
+			
+			resp = JSON.parse(res.body)
+			if resp['error'] == false
+				@cookie = res.header['set-cookie']
+				return ["error=false", "info=Logged in successfully."]
+			else
+				return ["error=true", "info=#{resp['reason']}"]
+			end
+		end
+		
+		# Creates a new mod. Requires authentication.
+		#
+		# @param name [String] Your new mod's name
+		# @param desc [String] Short description of your mod
+		# @param version [String] The latest friendly version of your mod
+		# @param ksp_ver [String] The KSP version this is compatible with
+		# @param license [String] Your mod's license
+		# @param zipball [File] The actual mod's zip file
+		# @return [Array] An array containing the published mod info.
+		def self.create_mod(params = {})
+			@name = params['name']
+			@desc = params['desc']
+			@version = params['version']
+			@ksp_ver = params['ksp_ver']
+			@license = params['license']
+			@zipball = params['zipball']
+			
+			url = URI.parse("https://kerbalstuff.com/api/mod/create")
+			
+			http = Net::HTTP.new(url.host, url.port)
+			http.use_ssl = true
+			http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+			
+			File.open(@zipball, "r") do |file|
+			
+				req = Net::HTTP::Post::Multipart.new url.path, "name" => @name, "short-description" => @desc, "version" => @version, "ksp-version" => @ksp_ver, "license" => @license, 
+					"zipball" => UploadIO.new(file, "application/zip", File.basename(file))
+				req.add_field("Cookie", @cookie)
+			
+				res = http.start do |http2|
+					http2.request(req)
+				end
+				
+				resp = JSON.parse(res.body)
+				
+				if resp['error'] == true
+					return ["error=true", "msg=#{resp['reason']}"]
+				else
+					return ["id=#{resp['id']}", "name=#{resp['name']}", "url=http:""/""/""kerbalstuff.com#{resp['url']}"]
+				end
+			end
+			
+		end
+		
+		# Publishes an update to an existing mod. Requires authentication. All parameters are required. Parameters are passed by via Hash.
+		#
+		# @param modid [Fixnum] The ID of the mod you want to update
+		# @param version [String] The friendly version number about to be created
+		# @param changelog [String] Markdown changelog
+		# @param ksp_ver [String] The version of KSP this is compatible with
+		# @param notify_followers [String] If "yes", email followers about this update
+		# @param zipball [File] The actual mod's zip file
+		# @return [Array] A string containing the updated version info.
+		def self.update_mod(params = {})
+			raise ArgumentError, "Params cannot be empty" if params.empty?
+			raise ArgumentError, "Missing one or more parameters" unless (params.has_key?("modid") && params.has_key?("version") && params.has_key?("changelog") && params.has_key?("ksp_ver") && params.has_key?("notify_followers") && params.has_key?("zipball"))
+			
+			modid = params['modid']
+			@version = params['version']
+			@changelog = params['changelog']
+			@ksp_ver = params['ksp_ver']
+			@notify_followers = params['notify_followers']
+			@zipball = params['zipball']
+			
+			url = URI.parse("https://kerbalstuff.com/api/mod/#{modid}/update")
+			
+			http = Net::HTTP.new(url.host, url.port)
+			http.use_ssl = true
+			http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+			
+			File.open(@zipball, "r") do |file|
+			
+				req = Net::HTTP::Post::Multipart.new url.path, "version" => @version, "changelog" => @changelog, "ksp-version" => @ksp_ver, "notify-followers" => @notify_followers, 
+					"zipball" => UploadIO.new(file, "application/zip", File.basename(file))
+				req.add_field("Cookie", @cookie)
+			
+				res = http.start do |http2|
+					http2.request(req)
+				end
+				
+				resp = JSON.parse(res.body)
+				
+				if resp['error'] == true
+					return ["error=true", "msg=#{resp['reason']}"]
+				else
+					return ["id=#{resp['id']}", "url=http:""/""/#{resp['url']}"]
+				end
+			end
+		end
+	end
+end

data/lib/kerbalstuff/mod.rb

@@ -33,7 +33,7 @@ module KerbalStuff
 		end
 		
 		def to_s
-			"Mod:\nname=#{@name}\nbackground=https:""/""/""cdn.mediacru.sh#{@background}\nlicense=#{@license}\nwebsite=#{@website}\ndonations=#{@donations}\nsource_code=#{@source_code}\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"
+			return ["name=#{@name}", "background=https:""/""/""cdn.mediacru.sh#{@background}", "license=#{@license}", "website=#{@website}", "donations=#{@donations}", "source_code=#{@source_code}", "author=#{@author}", "downloads=#{@downloads}", "id=#{@id}", "short_description=\"#{@short_description}\"", "versions=#{@versions}", "description_html=\"#{@description_html}\"", "followers=#{@followers}", "default_version_id=#{@default_version_id}", "description=\"#{@description}\""]
 		end
 	end
 	
@@ -52,7 +52,7 @@ module KerbalStuff
 		end
 		
 		def to_s
-			"ModVersion:\nversion=#{@version}, download=https:""/""/""kerbalstuff.com#{@download_path}, id=#{@id}, ksp_version=#{@ksp_version}, changelog=\"#{@changelog}\"\n"
+			["version=#{@version}", "download=https:""/""/""kerbalstuff.com#{@download_path}", "id=#{@id}", "ksp_version=#{@ksp_version}", "changelog=\"#{@changelog}\""]
 		end
 	end
 end

data/lib/kerbalstuff/user.rb

@@ -22,7 +22,7 @@ module KerbalStuff
 		end
 		
 		def to_s
-			"User:\nircNick=#{@ircNick}\nmods=#{@mods}\ntwitterUsername=#{@twitterUsername}\nusername=#{@username}\nredditUsername=#{@redditUsername}\nforumUsername=#{@forumUsername}\ndescription=\"#{@description}\"\n"
+			return ["ircNick=#{@ircNick}", "mods=#{@mods}", "twitterUsername=#{@twitterUsername}", "username=#{@username}", "redditUsername=#{@redditUsername}", "forumUsername=#{@forumUsername}", "description=\"#{@description}\""]
 		end
 		
 	end

data/lib/kerbalstuff/version.rb

@@ -1,3 +1,3 @@
 module KerbalStuff
-	VERSION = "0.2.0"
+	VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: KerbalStuff
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-25 00:00:00.000000000 Z
+date: 2014-11-20 00:00:00.000000000 Z
 dependencies: []
 description: A simple API wrapper for KerbalStuff
 email: rockytvbr@gmail.com
@@ -20,10 +20,13 @@ extra_rdoc_files:
 files:
 - .gitattributes
 - .gitignore
+- CHANGELOG.md
+- CONTRIBUTING.md
 - KerbalStuff.gemspec
 - LICENSE.txt
 - README.md
 - lib/KerbalStuff.rb
+- lib/kerbalstuff/auth.rb
 - lib/kerbalstuff/mod.rb
 - lib/kerbalstuff/user.rb
 - lib/kerbalstuff/version.rb
@@ -51,5 +54,5 @@ rubyforge_project:
 rubygems_version: 1.8.28
 signing_key: 
 specification_version: 3
-summary: KerbalStuff
+summary: KerbalStuff's Ruby API Wrapper
 test_files: []