lableb_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 939511b56c642e7cd8edaa7e2d2a69ea94ad4d69e03de67917a95d7c5d9bb47f
+  data.tar.gz: bb30281e4d485a6aca6d16df53f15ae341fd166cc32f1890beaa5baa1443eb14
+SHA512:
+  metadata.gz: a2c729ba7b71a790530fe827d59564d779d3c460cbe58ff4bc0ad1f45ca2db0e32b08084df2ff1402429fd02f982b2512dfa96db34c9aaf25dff63031c7f4be2
+  data.tar.gz: b5caed6a6c4175c3a7b83427df78fc5a7e13e7690920ac81c47ebebf303b37aa15e2193f79906eec65efe06a2afcfcf2732ecf56f7e4ff3c9ded71746ae41c96

data/lableb_sdk.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name = "lableb_sdk"
+  s.version = "1.0.0"
+  s.date = "2019-06-01"
+  s.summary = "lableb cloud search sdk"
+  s.description = "Lableb cloud search api sdk"
+  s.homepage = "https://gitlab.com/cse-sdk/ruby-sdk"
+  s.authors = ["Lableb"]
+  s.email = "support@lableb.com"
+  s.files = %w(lableb_sdk.gemspec) + Dir["lib/**/*.rb"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = ">=2.0.0"
+  s.license = "MIT"
+end

data/lib/lableb_client.rb

@@ -0,0 +1,63 @@
+require "net/http"
+require "net/https"
+require "json"
+
+module Lableb
+  class Client
+    def createRequest(url, headers)
+      http = Net::HTTP.new(url.host, url.port)
+      headers.each do | key, value |
+        req[key] = value
+      end
+      http.use_ssl = true
+      return http
+    end
+
+    def getJSON(url, qs = {}, headers = {})
+      uri = URI("#{url}?#{self.buildQueryString(qs)}")
+      http = self.createRequest(uri, headers)
+      req = Net::HTTP::Get.new(uri)
+      response = http.request(req)
+      return response
+    end
+
+    def postJSON(url, body = {}, qs = {}, headers = {})
+      uri = URI("#{url}?#{self.buildQueryString(qs)}")
+      http = self.createRequest(uri, headers)
+      req = Net::HTTP::Post.new(uri, { 'Content-Type': 'application/json' })
+      req.body = body.to_json
+      response = http.request(req)
+      return response
+    end
+
+    def deleteJSON(url, qs = {}, headers = {})
+      uri = URI("#{url}?#{self.buildQueryString(qs)}")
+      http = self.createRequest(uri, headers)
+      req = Net::HTTP::Delete.new(uri)
+      response = http.request(req)
+      return response
+    end
+
+    def buildQueryString(params)
+      res = []
+      params.each do | key, value |
+        if value.kind_of? Array
+          res.push(value.map{|el| "#{key}=#{el}"})
+        elsif value.is_a? Hash
+          value.each do | key2, val2 |
+            temp = {}
+            if val2.is_a? String
+              temp[key] = "#{key2}:\"#{val2}\""
+            elsif val2.is_a? Array
+              temp[key] = val2.map{|el| "#{key2}:\"#{el}\""}
+            end
+            res.push(buildQueryString(temp))
+          end
+        else
+          res.push("#{key}=#{value.to_s}")
+        end
+      end
+      res.join("&")
+    end
+  end
+end

data/lib/lableb_sdk.rb

@@ -0,0 +1,231 @@
+require "json"
+require "date"
+require "./lib/lableb_client"
+
+module Lableb
+  class SDK
+    def initialize(projectName, searchToken, indexingToken)
+      @projectName = projectName
+      @searchToken = searchToken
+      @indexingToken = indexingToken
+      @apiURL = "https://api-bahuth.lableb.com/api/v1"
+      @baseURL = "#{@apiURL}/#{@projectName}/collections"
+      @client = Lableb::Client.new
+      @customSessionID = nil
+    end
+
+    # Indexes documents to Lableb
+    # @param collection {String} - collection name in Lableb index
+    # @param document {Hash | Array} - docuemnts to index
+    def index(collection, documents)
+      docs = nil
+      if documents.kind_of? Array
+        docs = documents.map{|document| self.convertDates(document)}
+      else
+        docs = [self.convertDates(documents)]
+      end
+      url = "#{@baseURL}/#{collection}/documents"
+      response = @client.postJSON(url, docs, { token: @indexingToken })
+      indexed = response.code.to_i < 400
+      return indexed, response.code.to_i
+    end
+
+    # Searches documents on Lableb
+    # @param collection {String} - collection name in Lableb index
+    # @param params {Hash} - query string parameters
+    # @param handler {String} - search handler name
+    def search(collection, params, handler="default")
+      params['token'] = @searchToken
+      params['session_id'] = self.getSessionID()
+      url = "#{@baseURL}/#{collection}/search/#{handler}"
+      response = @client.getJSON(url, params)
+      code = response.code.to_i
+      data = JSON.parse(response.body)
+
+      if code >= 400
+        return data['response'], code
+      end
+
+      facets = {}
+      data['response']['facets'].map do |facet|
+        if facet[0] != "count"
+          facets[facet[0]] = facet[1]['buckets']
+        end
+      end
+
+      docuemntsWithFeedbackUrl = data['response']['results'].map.with_index do |document, idx|
+        document['feedbackUrl'] = self.generateSearchFeedbackUrl(collection, handler, document, idx + 1, params[:q])
+        document
+      end
+
+      return {
+        totalDocuments: data['response']['found_documents'],
+        documents: docuemntsWithFeedbackUrl,
+        facets: facets
+      }, code
+    end
+
+    # generates a feedback url for a search result
+    def generateSearchFeedbackUrl(collection, handler, document, order, query)
+      qs = @client.buildQueryString({
+        session_id: self.getSessionID(),
+        token: @searchToken,
+        query: query,
+        item_id: document['id'],
+        item_order: order,
+        url: document['url']
+      })
+      url = "#{@baseURL}/#{collection}/search/#{handler}/feedback/hits?#{qs}"
+      return url
+    end
+
+    # Gets autcomplete suggestions
+    # @param collection {String} - collection name in Lableb index
+    # @param params {Hash} - query string parameters
+    # @param handler {String} - autocomplete handler name
+    def autocomplete(collection, params, handler="suggest")
+      params['token'] = @searchToken
+      params['session_id'] = self.getSessionID()
+      url = "#{@baseURL}/#{collection}/autocomplete/#{handler}"
+      response = @client.getJSON(url, params)
+      data = JSON.parse(response.body)
+      code = response.code.to_i
+
+      if code >= 400
+        return data['response'], code
+      end
+
+      suggestionsWithFeedbackUrl = data['response']['results'].map.with_index do |suggestion, idx|
+        suggestion['feedbackUrl'] = self.generateAutocompleteFeedbackUrl(collection, handler, suggestion, idx + 1, params[:q])
+        suggestion
+      end
+
+      return {
+        totalSuggestions: data['response']['found_documents'],
+        suggestions: suggestionsWithFeedbackUrl
+      }
+    end
+
+    # generates autocomplete feedback url for an autocomplete suggestion
+    def generateAutocompleteFeedbackUrl(collection, handler, suggestion, order, query)
+      params = {
+        session_id: self.getSessionID(),
+        token: @searchToken,
+        query: query,
+        item_order: order
+      }
+
+      if suggestion['url']
+        params['url'] = suggestion['url']
+      end
+
+      qs = @client.buildQueryString(params)
+      url = "#{@baseURL}/#{collection}/autocomplete/#{handler}/feedback/hits?#{qs}"
+      return url
+    end
+
+    # Gets related posts to the specified one in passed params
+    # @param collection {String} - collection name in Lableb index
+    # @param params {Hash} - query string parameters
+    # @param handler {String} - recommendation handler name
+    def recommend(collection, params, handler="recommend")
+      params['token'] = @searchToken
+      params['session_id'] = self.getSessionID()
+      url = "#{@baseURL}/#{collection}/recommend/#{handler}"
+      response = @client.getJSON(url, params)
+      data = JSON.parse(response.body)
+      code = response.code.to_i
+
+      if code >= 400
+        return data['response'], code
+      end
+
+      recommendationsWithFeedbackUrl = data['response']['results'].map.with_index do |recommendation, idx|
+        recommendation['feedbackUrl'] = self.generateRecommendationFeedbackUrl(collection, handler, recommendation, idx + 1)
+        recommendation
+      end
+
+      return {
+        totalDocuments: data['response']['found_documents'],
+        documents: recommendationsWithFeedbackUrl
+      }
+    end
+
+    # generates recommendation hit feedback url, but the url needs to be completed with
+    # the source document params
+    def generateRecommendationFeedbackUrl(collection, handler, target, order)
+      params = {
+        session_id: self.getSessionID(),
+        token: @searchToken,
+        target_id: target['id'],
+        item_order: order
+      }
+
+      if target['url']
+        params['target_url'] = target['url']
+      end
+
+      if target['title']
+        params['target_title'] = target['title']
+      end
+
+      qs = @client.buildQueryString(params)
+      url = "#{@baseURL}/#{collection}/recommend/#{handler}/feedback/hits?#{qs}"
+      return url
+    end
+
+    # Deletes a document from Lableb index by id
+    # @param collection {String} - collection name in Lableb index
+    # @param id {String} - id of the document to be deleted
+    def delete(collection, id)
+      url = "#{@baseURL}/#{collection}/documents/#{id}"
+      response = @client.deleteJSON(url, { token: @indexingToken })
+      data = JSON.parse(response.body)
+      code = response.code.to_i
+
+      if code >= 400
+        return data['response'], code
+      end
+
+      return true, code
+    end
+
+    # covert each date in a document to ISO8601 date string
+    def convertDates(doc)
+      doc.each do | key, value |
+        if key[-2..key.length] == "dt"
+          doc[key] = self.toISODateString(value)
+        elsif key[-3..key.length] == "dta"
+          doc[key] = value.map{ | date | self.toISODateString(date) } 
+        end
+      end
+      doc
+    end
+
+    # convert a date object or a date string into ISO8601 date string
+    def toISODateString(date)
+      str = ""
+      if (date.kind_of? Date)
+        str = date.to_s
+      elsif date.is_a? String
+        str = date
+      end
+      dt = DateTime.parse(str).iso8601.split('+')[0] + "Z"
+      dt
+    end
+
+    # sets custom session id generator
+    def setSessionIDGenerator(method)
+      @customSessionID = method
+    end
+
+    # returns the custom session id generator if it exists
+    # else generates and returns a random string
+    def getSessionID()
+      if @customSessionID
+        return @customSessionID.call()
+      end
+      return rand(7958661109946400884391936).to_s(36)
+    end
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: lableb_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lableb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-01 00:00:00.000000000 Z
+dependencies: []
+description: Lableb cloud search api sdk
+email: support@lableb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lableb_sdk.gemspec
+- lib/lableb_client.rb
+- lib/lableb_sdk.rb
+homepage: https://gitlab.com/cse-sdk/ruby-sdk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: lableb cloud search sdk
+test_files: []