marketing_api 0.0.2 → 0.0.3

data/lib/marketing_api.rb

@@ -5,14 +5,30 @@ class MarketingAPI
 
 	attr_accessor :server, :port
 
+	# Initializes the API with optional server and port
+	# The protocol is HTTP and it cannot be changed
 	def initialize(server="web.ict.kth.se/~chyrkov", port=80)
 		@server = server
 		@port = port
 	end
 
-	#it is easy to go with get
+	# Validates URI based on @server and @port
+	def uri_valid?
+		URI.parse("http://#{@server}:#{@port}")
+		return true
+		rescue URI::InvalidURIError => err
+			return nil
+	end
+
+	# Gets an optin
+	# Params: 
+	# +id:: ID of the optin in the DB
+	# Returns optin as JSON if it is found, nil otherwise
 	def get_optin(id)
-		uri = URI.parse("http://web.ict.kth.se/~chyrkov:80/#{id}")
+		if !uri_valid?
+			return nil
+		end
+		uri = URI.parse("http://#{@server}:#{@port}/#{id }")
 		response = Net::HTTP.get_response(uri)
 		if response.code == "200"
 			return response.body
@@ -21,7 +37,14 @@ class MarketingAPI
 		end
 	end
 
+	# Creates an optin from JSON
+	# Returns true if it is created, nil otherwise
+	# Params:
+	# +json_string:: JSON to turn into an optin
 	def create_optin(json_string)
+		if !uri_valid?
+			return nil
+		end
 		req = Net::HTTP::Post.new("/create", initheader = {'Content-Type' =>'application/json'})
 		req.body = json_string
 		response = Net::HTTP.new(@server, @port).start {|http| http.request(req) }
@@ -32,7 +55,14 @@ class MarketingAPI
 		end
 	end
 
+	# Updates an optin from JSON
+	# Returns true if it is updated, nil if optin is not found or update failed
+	# Params:
+	# +json_string:: JSON to turn into an optin
 	def update_optin(json_string)
+		if !uri_valid?
+			return nil
+		end
 		req = Net::HTTP::Post.new("/update", initheader = {'Content-Type' =>'application/json'})
 		req.body = json_string
 		response = Net::HTTP.new(@server, @port).start {|http| http.request(req) }
@@ -43,7 +73,14 @@ class MarketingAPI
 		end
 	end
 
+	# Deactivates an optin
+	# Params: 
+	# +id:: ID of the optin in the DB
+	# Returns true if optin is deactivated, nil if optin is not found or deactivation failed
 	def deactivate_optin(id)
+		if !uri_valid?
+			return nil
+		end
 		req = Net::HTTP::Post.new("/deactivate/#{id}", initheader = {'Content-Type' =>'application/json'})
 		response = Net::HTTP.new(@server, @port).start {|http| http.request(req) }
 		if response.code == "200"

data/marketing_api.gemspec

@@ -3,7 +3,7 @@ require 'marketing_api'
 
 Gem::Specification.new do |s|
   s.name          = 'marketing_api'
-  s.version       = '0.0.2'
+  s.version       = '0.0.3'
   s.date          = '2013-07-02'
   s.summary       = "Working with Marketing class by means of remote API"
   s.description   = "Test task given by Alexander Simonov"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marketing_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -72,7 +72,6 @@ files:
 - Rakefile
 - bin/marketing_api.rb
 - lib/marketing_api.rb
-- marketing_api-0.0.1.gem
 - marketing_api.gemspec
 - spec/api_spec.rb
 - spec/spec_helper.rb