havenondemand 1.2.1 → 1.3.0

data/lib/havenondemand/version.rb

@@ -1,3 +1,3 @@
 module Havenondemand
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/lib/hodclient.rb

@@ -0,0 +1,275 @@
+require 'json'
+require 'Unirest'
+
+class HODClient
+  def initialize(apikey, version="v1")
+    # Instance variables
+    if apikey=='http://api.havenondemand.com' || apikey=='http://api.havenondemand.com/' || apikey=='https://api.havenondemand.com' || apikey=='https://api.havenondemand.com/'
+      raise ArgumentError, "Using an outdated wrapper constructor method. No need to include API URL.\nInclude as such:\n client = HODClient(API_KEY, VERSION)\n where version is optional"
+    end
+    @apikey = apikey
+    @ver = version
+    @hodAppBase = "https://api.havenondemand.com/1/api/";
+    @hodJobResultBase = "https://api.havenondemand.com/1/job/result/";
+    @hodJobStatusBase = "https://api.havenondemand.com/1/job/status/";
+    @hodCombineAsync = "async/executecombination";
+	  @hodCombineSync = "sync/executecombination";
+    @timeoutVal = 120
+  end
+
+
+  def get_job_status(jobID,callback)
+    data={"apikey"=>@apikey}
+    response=Unirest.post "#{@hodJobStatusBase}#{jobID}",
+                    headers:{ "Accept" => "application/json" },
+                    parameters:data
+    if response.code == 200
+      if callback != nil
+        callback.call(response.body)
+      else
+        return response.body
+      end
+    else
+      puts "Error: #{response.body}"
+      err = create_error_object(response.body["error"],response.body["reason"],response.body["detail"],"")
+      if callback != nil
+        callback.call(err)
+      else
+        return err
+      end
+    end
+  end
+
+  def get_job_result(jobID,callback)
+    data={"apikey"=>@apikey}
+    response=Unirest.post "#{@hodJobResultBase}#{jobID}",
+                      headers:{ "Accept" => "application/json" },
+                      parameters:data
+    if response.code == 200
+      if callback != nil
+        callback.call(response.body)
+      else
+        return response.body
+      end
+    else
+      err = create_error_object(response.body["error"],response.body["reason"],response.body["detail"],"")
+      if callback != nil
+        callback.call(err)
+      else
+        return err
+      end
+    end
+  end
+
+  def get_request(hodApp, params, async=false,callback)
+    url=''
+    if async == true
+        url = "#{@hodAppBase}async/#{hodApp}/#{@ver}?apikey=#{@apikey}"
+    else
+        url = "#{@hodAppBase}sync/#{hodApp}/#{@ver}?apikey=#{@apikey}"
+    end
+    params.each do |key, value|
+      if "#{key}" == "file"
+				raise ArgumentError, "File upload must be used with PostRequest method"
+      else
+        if value.kind_of?(Array)
+          value.each { |x|
+            p = "&#{key}=#{x}"
+            url = [url, p].join()
+          }
+        else
+          p = "&#{key}=#{value}"
+          url = [url, p].join()
+        end
+			end
+    end
+    Unirest.timeout(@timeoutVal)
+
+    response=Unirest.get ("#{url}")
+    if response.code == 200
+      if callback != nil
+        callback.call(response.body)
+      else
+        return response.body
+      end
+    else
+      puts "Error: #{response.body}"
+      err = create_error_object(response.body["error"],response.body["reason"],response.body["detail"],"")
+      if callback != nil
+        callback.call(err)
+      else
+        return err
+      end
+    end
+  end
+
+  def post_request(hodApp, params, async=true, callback)
+    endPoint = ''
+    if async == true
+      endPoint = "#{@hodAppBase}async/#{hodApp}/#{@ver}"
+    else
+      endPoint = "#{@hodAppBase}sync/#{hodApp}/#{@ver}"
+    end
+    data = {}
+    data.compare_by_identity
+    data["apikey"]=@apikey
+    params.each do |key, value|
+      if "#{key}" == "file"
+        if value.kind_of?(Array)
+          value.each { |file|
+            data["file"] =  File.new(file, 'rb')
+          }
+        else
+          data["file"] =  File.new(value, 'rb')
+        end
+      else
+        if value.kind_of?(Array)
+          value.each { |x|
+            data["#{key}"] =  x
+          }
+        else
+          data["#{key}"] =  value
+        end
+      end
+    end
+    Unirest.timeout(@timeoutVal)
+    response=Unirest.post endPoint,
+                        headers:{ "Accept" => "application/json", "Content-Type" => "application/json"},
+                        parameters:data
+
+    if response.code == 200
+      if callback != nil
+        callback.call(response.body)
+      else
+        return response.body
+      end
+    else
+      puts "Error: #{response.body}"
+      err = create_error_object(response.body["error"],response.body["reason"],response.body["detail"],"")
+      if callback != nil
+        callback.call(err)
+      else
+        return err
+      end
+    end
+  end
+
+  def get_request_combination(hodApp, params, async=false, callback)
+    url=''
+    if async == true
+        url = "#{@hodAppBase}#{@hodCombineAsync}/#{@ver}"
+    else
+        url = "#{@hodAppBase}#{@hodCombineSync}/#{@ver}"
+    end
+    url = [url, "?apikey=#{@apikey}&combination=#{hodApp}"].join()
+    params.each do |key, value|
+      if "#{key}" == "file"
+				raise ArgumentError, "File upload must be used with post_combination method"
+      else
+        if valid_json?(value)
+          raise ArgumentError, "JSON input must be used with post_combination method"
+        else
+          p = "\"{\"name\":\"#{key}\",\"value\":\"#{value}\"}\""
+          url =  [url, "&parameters=",p].join()
+        end
+			end
+    end
+    Unirest.timeout(@timeoutVal)
+
+    response=Unirest.get ("#{url}")
+    if response.code == 200
+      if callback != nil
+        callback.call(response.body)
+      else
+        return response.body
+      end
+    else
+      puts "Error: #{response.body}"
+      err = create_error_object(response.body["error"],response.body["reason"],response.body["detail"],"")
+      if callback != nil
+        callback.call(err)
+      else
+        return err
+      end
+    end
+  end
+
+  def post_request_combination(combinationName, params, async=false, callback)
+    endPoint=''
+    if async == true
+      endPoint = "#{@hodAppBase}#{@hodCombineAsync}/#{@ver}"
+    else
+      endPoint = "#{@hodAppBase}#{@hodCombineSync}/#{@ver}"
+    end
+    data = {}
+    data.compare_by_identity
+    data["apikey"]=@apikey
+    data["combination"] = combinationName
+
+    params.each do |key, value|
+      if "#{key}" == "file"
+        if value.kind_of?(Array)
+          for index in 0 ... value.size
+            value[index].each_pair {|kk,vv|
+            data["file_parameters"] =  kk
+            data["file"] =  File.new(vv, 'rb')
+           }
+          end
+        else
+          value.each_pair {|kk,vv|
+          data["file_parameters"] =  kk
+          data["file"] =  File.new(vv, 'rb')
+         }
+        end
+      else
+        if valid_json?(value)
+          p = "{\"name\":\"#{key}\",\"value\":#{value}}"
+          data["parameters"] =  p
+        else
+          p = "{\"name\":\"#{key}\",\"value\":\"#{value}\"}"
+          data["parameters"] =  p
+        end
+			end
+    end
+
+    Unirest.timeout(@timeoutVal)
+    response=Unirest.post endPoint,
+                        headers:{ "Accept" => "application/json", "Content-Type" => "application/json"},
+                        parameters:data
+
+    if response.code == 200
+      if callback != nil
+        callback.call(response.body)
+      else
+        return response.body
+      end
+    else
+      puts "Error: #{response.body}"
+      err = create_error_object(response.body["error"],response.body["reason"],response.body["detail"],"")
+      if callback != nil
+        callback.call(err)
+      else
+        return err
+      end
+    end
+  end
+
+  private
+  # internal utilitiy method
+  def valid_json?(json)
+    begin
+      JSON.parse(json)
+      return true
+    rescue JSON::ParserError => e
+      return false
+    end
+  end
+  def create_error_object(error,reason,detail,jobID)
+    errorObj = {}
+    errorObj["error"] = error
+    errorObj["reason"] = reason
+    errorObj["detail"] = detail
+    errorObj["jobID"] = jobID
+    return errorObj
+  end
+end

data/lib/hoderrorcode.rb

@@ -0,0 +1,13 @@
+class ErrorCode
+    TIMEOUT = 1600
+    IN_PROGRESS = 1610
+    QUEUED = 1620
+    NONSTANDARD_RESPONSE = 1630
+    INVALID_PARAM = 1640
+    INVALID_HOD_RESPONSE = 1650
+    UNKNOWN_ERROR = 1660
+    HTTP_ERROR = 1670
+    CONNECTION_ERROR = 1680
+    IO_ERROR = 1690
+    HOD_CLIENT_BUSY = 1700
+end

data/lib/hodresponseparser.rb

@@ -0,0 +1,88 @@
+require File.join(File.dirname(__FILE__), "/hoderrorcode.rb")
+
+class HODResponseParser
+  @errors
+  def initialize()
+    @errors = []
+  end
+
+  def parse_jobid(response)
+		@errors = []
+    puts response
+    if response.has_key? "jobID" and response["jobID"].length > 0
+			return response["jobID"]
+		else
+			if response.has_key? "error" and response.has_key? "reason"
+			  detail = ""
+				if response.has_key? "detail"
+					detail = response["detail"]
+				create_error_object(response["error"], response["reason"],detail,"")
+        end
+			else
+				create_error_object(ErrorCode::INVALID_HOD_RESPONSE, "Invalid HOD response","","")
+      end
+      return nil
+    end
+  end
+#
+  def parse_payload(response)
+		@errors = []
+		if response.has_key? "actions"
+			actions = response["actions"]
+			status = actions[0]["status"]
+			if status == "queued"
+				create_error_object(ErrorCode::QUEUED, "Task is queued","", response["jobID"])
+				return nil
+			elsif status == "in progress"
+				create_error_object(ErrorCode::IN_PROGRESS, "Task is in progress","", response["jobID"])
+				return nil
+			elsif status == "failed"
+				errors = actions[0]["errors"]
+        if errors.kind_of?(Array)
+          errors.each { |error|
+            detail = ""
+    				if error.has_key? "detail"
+    					detail = error["detail"]
+            end
+    				create_error_object(error["error"], error["reason"],detail,error["jobID"])
+          }
+        else
+          detail = ""
+    			if errors.has_key? "detail"
+    				detail = errors["detail"]
+          end
+    			create_error_object(errors["error"], errors["reason"],detail,errors["jobID"])
+        end
+				return nil
+			else
+				return actions[0]["result"]
+      end
+		else
+      # must make sure this is an error message. Not just an error key from a good result
+			if response.has_key? "error" and response.has_key? "reason"
+        detail = ""
+				if response.has_key? "detail"
+					detail = response["detail"]
+				create_error_object(response["error"], response["reason"],detail,"")
+				return nil
+        end
+			else
+				return response
+      end
+    end
+  end
+
+  def get_last_errors()
+    return @errors
+  end
+#
+  private
+  def create_error_object(error,reason,detail,jobID)
+    errorObj = {}
+    errorObj["error"] = error
+    errorObj["reason"] = reason
+    errorObj["detail"] = detail
+    errorObj["jobID"] = jobID
+    @errors.push(errorObj)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: havenondemand
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Phong Vu
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-06 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unirest
@@ -66,11 +66,21 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- examples/examples.rb
-- examples/testhelper.rb
+- examples/attendant_test.mp3
+- examples/call_post_request_combination.rb
+- examples/callback_async.rb
+- examples/callback_sync.rb
+- examples/post_file.rb
+- examples/post_multiple_files.rb
+- examples/returnresponse_async.rb
+- examples/returnresponse_sync.rb
+- examples/review.jpg
 - havenondemand.gemspec
 - lib/havenondemand.rb
 - lib/havenondemand/version.rb
+- lib/hodclient.rb
+- lib/hoderrorcode.rb
+- lib/hodresponseparser.rb
 homepage: https://github.com/HP-Haven-OnDemand/havenondemand-ruby
 licenses:
 - MIT

data/examples/examples.rb

@@ -1,67 +0,0 @@
-require_relative "../lib/havenondemand.rb"
-
-$apikey="yourapikey"
-
-
-
-def test_post
-  client= HODClient.new("http://api.idolondemand.com",$apikey)
-  r=client.post("querytextindex",{:text=>"hello",:absolute_max_result=>1000})
-  puts "\n",r.json()["documents"][0]["reference"],"\n"
-end
-
-
-def test_post_async
-  client= HODClient.new("http://api.idolondemand.com",$apikey)
-  r=client.post("querytextindex",{:text=>"hello"},async=true)
-  #returns jobid
-  puts r.jobID
-  # will return status of call, queued or finished
-  puts r.status().json()
-  # Will wait until result to return
-  puts r.result().json()
-end
-
-
-
-def test_indexing(index="mytestindex")
-  client= HODClient.new("http://api.idolondemand.com",$apikey)
-  index=client.getIndex("myrssdb")
-
-  doc={:title=>"title",:reference=>"ref",:content=>"content"}
-  index.pushDoc(doc)
-  puts index.commit().json()
-end
-
-
-
-def test_createIndex
-  client= HODClient.new("http://api.idolondemand.com",$apikey)
-  index=client.createIndex("mytestindex",flavor="explorer")
-  puts index.json()
-end
-
-
-
-def test_deleteIndex
-  client= HODClient.new("http://api.idolondemand.com",$apikey)
-  puts client.deleteIndex("mytestindex")
-end
-
-def test_createConnector
-  client= HODClient.new("http://api.idolondemand.com",$apikey)
-  conn=HODConnector.new("mytestconnector",client)
-  puts conn.create(type="web",config={ "url" => "http://www.idolondemand.com" })
-  puts conn.delete()
-end
-
-def test_sentiment
-
-  client= HODClient.new("http://api.idolondemand.com",$apikey)
-  r=client.post('analyzesentiment',{'text'=>'I like cats'})
-  puts r.json()
-end
-
-test_sentiment()
-
-#test_createIndex()