marketing_api 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+gemspec
+
+

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    marketing_api (0.0.1)
+      json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    crack (0.4.0)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.4)
+    json (1.8.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    safe_yaml (0.9.3)
+    webmock (1.12.3)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  marketing_api!
+  rspec (~> 2.13.0)
+  webmock

data/README.md

@@ -0,0 +1,41 @@
+marketing_api_gem
+=================
+
+The gem is used as a remote API (using Net::HTTP) for the service called marketing (https://github.com/fess89/marketing). 
+
+Installation
+------------
+
+mkdir marketing_api_gem
+
+cd marketing_api_gem
+
+git clone https://github.com/fess89/marketing_api_gem .
+
+rake build
+
+Installation for testing
+------------------------
+mkdir marketing_api_gem
+
+cd marketing_api_gem
+
+git clone https://github.com/fess89/marketing_api_gem .
+
+Then alternatively:
+
+rake dev (this doesn't work for me)
+
+or 
+
+gem install rspec
+
+gem install webmock
+
+rake build
+
+rake (this runs tests)
+
+
+
+

data/Rakefile

@@ -0,0 +1,28 @@
+#gem installation
+task :build do 
+	#getting gem info
+	gemspec = eval(File.read("marketing_api.gemspec"))
+	system "gem build marketing_api.gemspec"
+	#system "gem install marketing_api-#{gemspec.version.to_s}.gem --no-ri --no-rdoc"
+end
+
+#installation for development purposes
+task :dev do 
+	#getting gem info
+	gemspec = eval(File.read("marketing_api.gemspec"))
+	system "gem build marketing_api.gemspec"
+	system "gem install marketing_api-#{gemspec.version.to_s}.gem --no-ri --no-rdoc --development -V"
+end
+
+#by default, rake runs tests
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new do |task|
+    task.pattern = "spec/*_spec.rb"
+    task.rspec_opts = Dir.glob("[0-9][0-9][0-9]_*").collect { |x| "-I#{x}" }.sort
+    task.rspec_opts << '--color'
+    task.rspec_opts << '-f documentation'
+end

data/bin/marketing_api.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'marketing_api'
+rescue LoadError
+  require 'rubygems'
+  require 'marketing_api'
+end

data/lib/marketing_api.rb

@@ -0,0 +1,55 @@
+require 'net/http'
+require 'uri'
+
+class MarketingAPI 
+
+	attr_accessor :server, :port
+
+	def initialize(server="web.ict.kth.se/~chyrkov", port=80)
+		@server = server
+		@port = port
+	end
+
+	#it is easy to go with get
+	def get_optin(id)
+		uri = URI.parse("http://web.ict.kth.se/~chyrkov:80/#{id}")
+		response = Net::HTTP.get_response(uri)
+		if response.code == "200"
+			return response.body
+		else
+			return nil
+		end
+	end
+
+	def create_optin(json_string)
+		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) }
+		if response.code == "200"
+			return true
+		else
+			return nil
+		end
+	end
+
+	def update_optin(json_string)
+		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) }
+		if response.code == "200"
+			return true
+		else
+			return nil
+		end
+	end
+
+	def deactivate_optin(id)
+		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"
+			return true
+		else
+			return nil
+		end
+	end
+end

data/marketing_api.gemspec

@@ -0,0 +1,30 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'marketing_api'
+
+Gem::Specification.new do |s|
+  	s.name          = 'marketing_api'
+  	s.version       = '0.0.1'
+  	s.date          = '2013-07-02'
+  	s.summary       = "Working with Marketing class by means of remote API"
+    	s.description   = "Test task given by Alexander Simonov"
+  	s.authors       = ["Oleksii Chyrkov"]
+  	s.email         = 'chyrkov@kth.se'
+	s.homepage      = ""
+	  
+	s.files         = `git ls-files`.split("\n")
+    	s.test_files    = `git ls-files -- spec/*`.split("\n")
+    	s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+    	s.require_paths = ["lib"]
+
+  	s.license      = "MIT"
+  	s.platform     = Gem::Platform::RUBY
+
+  	#json is needed to interact with the remote API
+	s.add_runtime_dependency "json"
+
+	#rspec is only for testing
+	s.add_development_dependency "rspec", "~> 2.13.0" 
+	
+	#so is webmock
+	s.add_development_dependency "webmock"
+end

data/spec/api_spec.rb

@@ -0,0 +1,184 @@
+require 'webmock/rspec'
+require 'json'
+require 'spec_helper'
+require 'marketing_api'
+
+describe MarketingAPI, "#marketing_remote_api" do
+
+	api = MarketingAPI.new
+	WebMock.disable_net_connect!
+
+	success_reply = 
+	{
+		"id"=>21, "email"=>"chyrkov@kth.se", 
+		"mobile"=>"380632721593", "first_name"=>"Oleksii", 
+		"last_name"=>"Chyrkov", "permission_type"=>"one-time", 
+		"channel"=>"sms", "company_name"=>"Apple", 
+		"message"=>"Found optin", "code"=>200
+	}
+
+	not_found_reply = 
+	{
+		"code"=> 404, 
+		"message"=>"Optin not found"
+	}
+
+	bad_request_reply = 
+	{
+		"code"=> 401, 
+		"message"=>"Bad request"
+	}
+
+	already_exists_reply = 
+	{
+		"code"=> 302, 
+		"message"=>"Bad request"
+	}
+
+	params = 
+	{ 	
+		:email => "chyrkov@kth.se",
+		:mobile => "380632721593",
+		:company_name => "Apple",
+		:first_name => "Oleksii",
+		:last_name => "Chyrkov",
+		:permission_type => "one-time",
+		:channel => "sms"
+	}
+
+	#TODO: return JSON here
+	it "should return valid JSON when getting an existing Optin" do
+		id = rand(10)
+		stub_request(:get, "#{api.server}:#{api.port}/#{id}").to_return(
+																:status => 200,
+																:body => success_reply)
+		json = api.get_optin(id).to_json
+		#JSON validation is defined in the helper
+		json.valid_json?.should eq(true)
+	end
+
+	it "should return true when creating an Optin with good params" do
+	 	stub_request(:post, api.server+":80/create").with(:body => params.to_json)
+	 												.to_return(:status => 200, :body => success_reply)
+		api.create_optin(params.to_json).should eq(true)
+	end
+
+	it "should return true when updating an existing Optin" do
+		params[:id] = rand(10)
+		stub_request(:post, api.server+":80/update").with(:body => params.to_json)
+	 													  .to_return(:status => 200, 
+	 													  			 :body => success_reply)
+		api.update_optin(params.to_json).should eq(true)
+	end
+
+	it "should return true when deactivating an existing Optin" do
+		id = rand(10)
+		success_reply = 
+		{
+			:message => "Optin with id #{id} deactivated",
+			:code => 200
+		}
+		stub_request(:post, api.server+":80/deactivate/#{id}").to_return(:status => 200, 
+																:body => success_reply)
+		api.deactivate_optin(id).should eq(true)
+	end
+
+	it "should return nil when creating from invalid JSON" do
+		#random string instead of JSON request
+		request = (0..60).map{ ('a'..'z').to_a[rand(26)] }.join
+		stub_request(:post, api.server+":80/create").with(:body => request)
+	 												.to_return(:status => 503, 
+	 														   :body => bad_request_reply)
+		api.create_optin(request).should eq(nil)
+	end
+
+	it "should return nil when updating from invalid JSON" do
+		#random string instead of JSON request
+		request = (0..60).map{ ('a'..'z').to_a[rand(26)] }.join
+		stub_request(:post, api.server+":80/update").with(:body => request)
+	 												.to_return(:status => 503, 
+	 														   :body => bad_request_reply)
+		api.update_optin(request).should eq(nil)
+	end
+
+	it "should return nil when creating an Optin with no email" do
+		params[:email] = ""
+		stub_request(:post, api.server+":80/create").with(:body => params.to_json)
+													.to_return(:status => 404, :body => bad_request_reply)
+		api.create_optin(params.to_json).should eq(nil)
+	end
+
+	it "should return nil when creating an Optin with no company name" do
+		params[:company_name] = ""
+		stub_request(:post, api.server+":80/create").with(:body => params.to_json)
+													.to_return(:status => 404, :body => bad_request_reply)
+		api.create_optin(params.to_json).should eq(nil)
+	end
+
+
+	it "should return nil when creating an Optin with no first name" do
+		params[:first_name] = nil		
+		stub_request(:post, api.server+":80/create").with(:body => params.to_json)
+													.to_return(:status => 404, :body => bad_request_reply)
+		api.create_optin(params.to_json).should eq(nil)
+	end
+
+	it "should return nil when creating an Optin with no last name" do
+		params[:last_name] = nil
+		stub_request(:post, api.server+":80/create").with(:body => params.to_json)
+													.to_return(:status => 404, :body => bad_request_reply)
+		api.create_optin(params.to_json).should eq(nil)
+	end
+
+	it "should return nil when creating an Optin with wrong permission type" do
+		#random string in permission type
+		params[:permission_type] = (0..9).map{ ('a'..'z').to_a[rand(26)] }.join
+		stub_request(:post, api.server+":80/create").with(:body => params.to_json)
+													.to_return(:status => 404, :body => bad_request_reply)
+		api.create_optin(params.to_json).should eq(nil)
+	end
+
+	it "should return nil when creating an Optin with wrong channel" do
+		#random string in channel
+		params[:channel] = (0..9).map{ ('a'..'z').to_a[rand(26)] }.join
+		stub_request(:post, api.server+":80/create").with(:body => params.to_json)
+													.to_return(:status => 404, :body => bad_request_reply)
+		api.create_optin(params.to_json).should eq(nil)
+	end
+
+	it "should return nil when getting a non-existent Optin" do
+		#IDs so big probably do not exist
+		id = rand(30000..40000)
+		stub_request(:get, "#{api.server}:#{api.port}/#{id}").to_return(
+																:status => 404,
+																:body => not_found_reply)
+		api.get_optin(id).should eq(nil)
+	end
+
+	it "should return nil when updating a non-existent Optin" do
+		params[:id] = rand(30000..40000).to_s
+		stub_request(:post, api.server+":80/update").with(:body => params.to_json)
+	 												.to_return(:status => 404,
+															   :body => not_found_reply)
+		api.update_optin(params.to_json).should eq(nil)
+	end
+
+	it "should return nil when deactivating a non-existent Optin" do
+		id = rand(30000..40000)
+		stub_request(:post, api.server+":80/deactivate/#{id}").to_return(:status => 404,
+															   			 :body => not_found_reply)
+		api.deactivate_optin(id).should eq(nil)
+	end
+
+	it "should return nil when creating a duplicate company/channel pair Optin" do
+		params[:id] = rand(10)
+		stub_request(:post, api.server+":80/update").with(:body => params.to_json)
+	 												.to_return(:status => 200, :body => success_reply)
+		api.update_optin(params.to_json).should eq(true)
+		stub_request(:post, api.server+":80/update").with(:body => params.to_json)
+	 												.to_return(:status => 302,
+															   :body => already_exists_reply)
+		api.update_optin(params.to_json).should eq(nil)
+	end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+class String
+	def valid_json?
+		JSON.parse(self)  
+		return true  
+		rescue JSON::ParserError
+  			return false
+  	end
+end
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: marketing_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Oleksii Chyrkov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Test task given by Alexander Simonov
+email: chyrkov@kth.se
+executables:
+- marketing_api.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/marketing_api.rb
+- lib/marketing_api.rb
+- marketing_api.gemspec
+- spec/api_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Working with Marketing class by means of remote API
+test_files:
+- spec/api_spec.rb
+- spec/spec_helper.rb