client_api 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d1f3ecfc9fe23b33756fbbcd4cbc2d86c3ad166
-  data.tar.gz: b3adbd713f6d21955fc00ec9943ec02d47bbbb1b
+  metadata.gz: 883253d3ae47c4132a521511271f056c2f52e79f
+  data.tar.gz: aeb25348fd8139ae8e1a464d3e90761bd1d1863b
 SHA512:
-  metadata.gz: 145d09183ae20cb0a75608423676e21252b1f0e0fec28d6e0dd2e1a23aa07c349e2d4c0223c1c4e2e28f97a882d955ff84dcdb2f75980aa645fb469a2fc93e80
-  data.tar.gz: 813552e93602c59d38ca62b73740f5e4d528bdd168dd2924663c307c0a4fd0e999957590b849b8a4611e970d00d25b041aff2f5ceee1717f48c0fecd19e5c08c
+  metadata.gz: e44e30edc44430b4f7505b03d09058162d0e1d98bc580a959620a0c5eb6e1c0d3b68937aa22b4fee294ee3440e28867d3c241c2e34c30079fb726bf20222b6b8
+  data.tar.gz: 8e7189827df613fccbe0c433ed873922af5bf5d014402a6614cfe13d5718226357325b42d1d32cfbedc7a04319e9b0815257f25172765ef031269b3e3055a204

data/lib/client_api/handler.rb

@@ -11,54 +11,65 @@ class Handler
 
   def self.load_data(params)
     waited_keys = [:engine_name,:data]
-    resp = invoke('/apps/load_data','POST',params)
-    resp.code == 200 ? true : false
+    if valid_reco_parameter(params,waited_keys)
+      resp = invoke('/apps/load_data','POST',params)
+      resp.code == 200 ? true : false
+    else
+      false
+    end
   end
 
   def self.similar_users(params)
-    waited_keys = [:engine_name,:user_id,:nb_of_similars]
-    resp = invoke('/users/similar','POST',params)
-    resp.code == 200 ? resp.body : false
+    waited_keys = [:engine_name,:api_key,:id,:nb_wanted]
+    if valid_reco_parameter(params,waited_keys) && valid_parameter_type?(params)
+      resp = invoke('/users/similar','POST',params)
+      resp.code == 200 ? resp.body : false
+    else
+      false
+    end
   end
 
   def self.similar_items(params)
-    waited_keys = [:engine_name,:item_id,:nb_of_similars]
-    resp = invoke('/items/similar','POST',params)
-    resp.code == 200 ? resp.body : false
+    waited_keys = [:engine_name,:api_key,:id,:nb_wanted]
+    if valid_reco_parameter(params,waited_keys) && valid_parameter_type?(params)
+      resp = invoke('/items/similar','POST',params)
+      resp.code == 200 ? resp.body : false
+    else
+      false
+    end
   end
 
   def self.recommend(params)
-    waited_keys = [:engine_name,:user_id,:nb_of_recommendations]
-    resp = invoke('/users/recommend','POST',params)
-    resp.code == 200 ? resp.body : false
+    waited_keys = [:engine_name,:api_key,:id,:nb_wanted]
+    if valid_reco_parameter(params,waited_keys) && valid_parameter_type?(params)
+      resp = invoke('/users/recommend','POST',params)
+      resp.code == 200 ? resp.body : false
+    else
+      false
+    end
   end
 
   private #######################################
 
-  #launch a request to the api server
   def self.get_response(request,url,param)
       request[:post] ? response = RestClient.post(url,param) : response = RestClient.get(url, {:params => param})
       response
   end
 
-  #return the response's code
   def self.get_code(response)
     response.code
   end
 
-  #return the correct url to the api server
   def self.get_url(url)
       return API_SERVER+url
   end
 
-  #determines the restfull method
   def self.get_request(type)
       request = {post: false,get: false}
       type == 'POST' ? request[:post] = true : request[:get] = true
       request
   end
 
-  #invoke the api et return the response
   def self.invoke(uri,req,params)
     request  = get_request(req)
     url      = get_url(uri)
@@ -66,12 +77,10 @@ class Handler
     return response
   end
 
-  #determines if the passed parameter is a hash
   def self.valid_parameter?(param)
     param.is_a?(Hash)
   end
 
-  #determines if the waited keys are present in the parameter
   def self.valid_keys?(param,waited_keys)
     waited_keys.each do |k|
       if !(param.has_key?(k))
@@ -82,7 +91,6 @@ class Handler
     return true
   end
 
-  #determines if the parameter's values are not empty Hash
   def self.valid_values?(param)
     parameter = {object: JSON.parse(param[:object],symbolize_names: true),option: JSON.parse(param[:option],symbolize_names: true)}
     values = parameter.values
@@ -95,7 +103,6 @@ class Handler
     return true
   end
 
-  #determines if the option is valid
   def self.valid_option?(option)
     option = JSON.parse(option,symbolize_names: true)
     waited_keys = [:user,:app]
@@ -117,7 +124,6 @@ class Handler
     end
   end
 
-  #determines if the object's keys are valid
   def self.valid_object_keys?(keys,object_keys)
     object_keys.each do |k|
       unless keys.include?(k)
@@ -128,7 +134,6 @@ class Handler
     return true
   end
 
-  #determines if the object's values are valid
   def self.valid_object_values?(values)
     values.each do |v|
       if v.nil?  || !(v.is_a?(String)) || v.empty?
@@ -139,7 +144,6 @@ class Handler
     return true
   end
 
-  #determines if the object is valid
   def self.valid_param_object?(object_keys,keys,values)
     response = true
     if !(valid_object_keys?(keys,object_keys)) || !(valid_object_values?(values))
@@ -148,7 +152,6 @@ class Handler
     response
   end
 
-  #determines if the object is valid according to the true option
   def self.valid_object?(object,option)
     object = JSON.parse(object,symbolize_names: true)
     option = JSON.parse(option,symbolize_names: true)
@@ -163,12 +166,18 @@ class Handler
     end
   end
 
-  #validate each method's parameter
+  def self.valid_parameter_type?(params)
+    params[:engine_name].is_a?(String) && params[:api_key].is_a?(String) && params[:id].is_a?(Fixnum) && params[:nb_wanted].is_a?(Fixnum)
+  end
+
   def self.validate(param,waited_keys)
     valid_parameter?(param) && valid_keys?(param,waited_keys) && valid_values?(param) && valid_option?(param[:option]) && valid_object?(param[:object],param[:option])
   end
 
-  #invoke the api and analyze the response's code
+  def self.valid_reco_parameter(param,waited_keys)
+    valid_parameter?(param) && valid_keys?(param,waited_keys)
+  end
+
   def self.call_api(params,short_uri,rest_req,waited_keys)
    if validate(params,waited_keys)
      response = invoke(short_uri,rest_req,params)

data/lib/client_api/version.rb

@@ -1,3 +1,3 @@
 module ClientApi
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/handler_spec.rb

@@ -91,19 +91,50 @@ describe Handler do
 
   describe '.similar_users' do
     context "When similar users are found" do
-      it {expect(Handler.similar_users(params_user_based)).to_not eq nil }
+      it {expect(Handler.similar_users(params_user_based)).to_not eq false }
+    end
+    context "When similar_users parameter are not valid" do
+      param = {engine_name: 1,api_key: '926eb0b0-e99d-0131-7e06-080027ab4d7b',id: 1,nb_wanted: 2}
+      it {expect(Handler.similar_users(param)).to eq false }
+      param = {engine_name: "eng869",api_key: 2,id: 1,nb_wanted: 2}
+      it {expect(Handler.similar_users(param)).to eq false }
+      param = {engine_name: "eng869",api_key: '926eb0b0-e99d-0131-7e06-080027ab4d7b',id: '1',nb_wanted: 2}
+      it {expect(Handler.similar_users(param)).to eq false }
+      param = {engine_name: 1,api_key: '926eb0b0-e99d-0131-7e06-080027ab4d7b',id: 1,nb_wanted: '2'}
+      it {expect(Handler.similar_users(param)).to eq false }
     end
   end
 
   describe '.similar_items' do
     context "When similar items are found" do
-      it {expect(Handler.similar_items(params_item_based)).to_not eq nil }
+      it {expect(Handler.similar_items(params_item_based)).to_not eq false }
+    end
+    context "When similar_users parameter are not valid" do
+      param = {engine_name: 1,api_key: '926eb0b0-e99d-0131-7e06-080027ab4d7b',id: 1,nb_wanted: 2}
+      it {expect(Handler.similar_items(param)).to eq false }
+      param = {engine_name: "eng111",api_key: 2,id: 1,nb_wanted: 2}
+      it {expect(Handler.similar_items(param)).to eq false }
+      param = {engine_name: "eng111",api_key: '926eb0b0-e99d-0131-7e06-080027ab4d7b',id: '1',nb_wanted: 2}
+      it {expect(Handler.similar_items(param)).to eq false }
+      param = {engine_name: 1,api_key: '926eb0b0-e99d-0131-7e06-080027ab4d7b',id: 1,nb_wanted: '2'}
+      it {expect(Handler.similar_items(param)).to eq false }
     end
   end
 
   describe '.recommend' do
     context "When recommendations are sent" do
-      it {expect(Handler.recommend(params_item_based)).to_not eq nil }
+      it {expect(Handler.recommend(params_item_based)).to_not eq false }
+    end
+
+    context "When similar_users parameter are not valid" do
+      param = {engine_name: 1,api_key: '926eb0b0-e99d-0131-7e06-080027ab4d7b',id: 1,nb_wanted: 2}
+      it {expect(Handler.recommend(param)).to eq false }
+      param = {engine_name: "eng111",api_key: 2,id: 1,nb_wanted: 2}
+      it {expect(Handler.recommend(param)).to eq false }
+      param = {engine_name: "eng111",api_key: '926eb0b0-e99d-0131-7e06-080027ab4d7b',id: '1',nb_wanted: 2}
+      it {expect(Handler.recommend(param)).to eq false }
+      param = {engine_name: 1,api_key: '926eb0b0-e99d-0131-7e06-080027ab4d7b',id: 1,nb_wanted: '2'}
+      it {expect(Handler.recommend(param)).to eq false }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: client_api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - 'fabira && atakem '
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-11 00:00:00.000000000 Z
+date: 2014-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler