boxx_loki 1.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdd9410bcce94de57864ce1a27dbaadf342c4641
+  data.tar.gz: 6c63d3cc9c3eb530171491d77f53b2e03cf4bbee
+SHA512:
+  metadata.gz: 05e32c97d003f840a68339dd314254930169b7f546f186d015400d1004ff5c10e07ef2548fe65c0fa48f12576286f084f0ebb27a3a0e563071355f0e1a4d72a2
+  data.tar.gz: ef527d8def2a04b0bbe32dd831af59d560a7d10caabe40206ad36d69566585ed2a5f2e2bb93a23af3de8dde9545e82a99b526c9b555c36b89def8d3bf17c3bfd

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,91 @@
+# boxx_loki
+
+BoxxLoki - the Ruby gem for the Recommendation API 2
+
+No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.5.0
+- Package version: 1.5.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build boxx_loki.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./boxx_loki-1.5.0.gem
+```
+(for development, run `gem install --dev ./boxx_loki-1.5.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'boxx_loki', '~> 1.5.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
+
+    gem 'boxx_loki', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'boxx_loki'
+
+api_instance = BoxxLoki::RecommendationApi.new
+
+request_data = BoxxLoki::RecommendationRequestData.new # RecommendationRequestData | request data
+
+
+begin
+  result = api_instance.root_post(request_data)
+  p result
+rescue BoxxLoki::ApiError => e
+  puts "Exception when calling RecommendationApi->root_post: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://loki.boxx.ai*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*BoxxLoki::RecommendationApi* | [**root_post**](docs/RecommendationApi.md#root_post) | **POST** / | 
+
+
+## Documentation for Models
+
+ - [BoxxLoki::InlineResponse200](docs/InlineResponse200.md)
+ - [BoxxLoki::InlineResponse400](docs/InlineResponse400.md)
+ - [BoxxLoki::RecommendationRequestData](docs/RecommendationRequestData.md)
+ - [BoxxLoki::RecommendationRequestDataQuery](docs/RecommendationRequestDataQuery.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/boxx_loki.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+#
+=begin
+#Recommendation API 2
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.5.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "boxx_loki/version"
+
+Gem::Specification.new do |s|
+  s.name        = "boxx_loki"
+  s.version     = BoxxLoki::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rajat Mhetre"]
+  s.email       = ["aida@boxx.ai"]
+  s.homepage    = "https://github.com/swagger-api/swagger-codegen"
+  s.summary     = "Recommendation API 2 Ruby Gem"
+  s.description = "Boxx.ai's recommendation sdk"
+  # TODO uncommnet and update below with a proper license
+  #s.license     = "Apache 2.0"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/InlineResponse200.md

@@ -0,0 +1,10 @@
+# BoxxLoki::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_status** | **BOOLEAN** |  | [optional] 
+**result** | **Object** |  | [optional] 
+**request** | **Object** |  | [optional] 
+
+

data/docs/InlineResponse400.md

@@ -0,0 +1,9 @@
+# BoxxLoki::InlineResponse400
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_status** | **Integer** |  | [optional] 
+**result** | **String** |  | [optional] 
+
+

data/docs/RecommendationApi.md

@@ -0,0 +1,55 @@
+# BoxxLoki::RecommendationApi
+
+All URIs are relative to *http://loki.boxx.ai*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**root_post**](RecommendationApi.md#root_post) | **POST** / | 
+
+
+# **root_post**
+> InlineResponse200 root_post(request_data)
+
+
+
+Get Recommendations 
+
+### Example
+```ruby
+# load the gem
+require 'boxx_loki'
+
+api_instance = BoxxLoki::RecommendationApi.new
+
+request_data = BoxxLoki::RecommendationRequestData.new # RecommendationRequestData | request data
+
+
+begin
+  result = api_instance.root_post(request_data)
+  p result
+rescue BoxxLoki::ApiError => e
+  puts "Exception when calling RecommendationApi->root_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_data** | [**RecommendationRequestData**](RecommendationRequestData.md)| request data | 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/RecommendationRequestData.md

@@ -0,0 +1,14 @@
+# BoxxLoki::RecommendationRequestData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** |  | 
+**access_token** | **String** |  | 
+**channel_id** | **String** |  | 
+**widget_type** | **String** |  | [optional] 
+**widget_instance** | **String** |  | [optional] 
+**page_url** | **String** |  | [optional] 
+**query** | [**RecommendationRequestDataQuery**](RecommendationRequestDataQuery.md) |  | 
+
+

data/docs/RecommendationRequestDataQuery.md

@@ -0,0 +1,31 @@
+# BoxxLoki::RecommendationRequestDataQuery
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userid** | **String** |  | [optional] 
+**boxx_token_id** | **String** |  | [optional] 
+**get_product_properties** | **BOOLEAN** |  | [optional] [default to false]
+**num** | **Integer** |  | [optional] 
+**user_attribute_weight** | **Float** |  | [optional] 
+**transaction_weight** | **Float** |  | [optional] 
+**group_by_attribute** | **BOOLEAN** |  | [optional] 
+**location** | **Array<Float>** |  | [optional] 
+**radius** | **Integer** |  | [optional] 
+**item_filters** | **Object** |  | [optional] 
+**recent_actions** | **Object** |  | [optional] 
+**repeat** | **BOOLEAN** |  | [optional] [default to true]
+**exclude** | **Array<String>** |  | [optional] 
+**num_out_of** | **Float** |  | [optional] 
+**offset** | **Float** |  | [optional] 
+**random** | **Float** |  | [optional] 
+**related_products** | **Array<String>** |  | [optional] 
+**related_action_type** | **String** |  | [optional] 
+**dont_repeat_transaction_types** | **Array<String>** |  | [optional] 
+**product_ids** | **Array<String>** |  | [optional] 
+**page_num** | **Float** |  | [optional] 
+**maximize** | **String** |  | [optional] 
+**latest_transactions** | **BOOLEAN** |  | [optional] [default to false]
+**ignore_filters** | **BOOLEAN** |  | [optional] [default to false]
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id=""
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id=""
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note=""
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/boxx_loki.rb

@@ -0,0 +1,44 @@
+=begin
+#Recommendation API 2
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.5.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+# Common files
+require 'boxx_loki/api_client'
+require 'boxx_loki/api_error'
+require 'boxx_loki/version'
+require 'boxx_loki/configuration'
+
+# Models
+require 'boxx_loki/models/inline_response_200'
+require 'boxx_loki/models/inline_response_400'
+require 'boxx_loki/models/recommendation_request_data'
+require 'boxx_loki/models/recommendation_request_data_query'
+
+# APIs
+require 'boxx_loki/api/recommendation_api'
+
+module BoxxLoki
+  class << self
+    # Customize default settings for the SDK using block.
+    #   BoxxLoki.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/boxx_loki/api/recommendation_api.rb

@@ -0,0 +1,78 @@
+=begin
+#Recommendation API 2
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.5.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require "uri"
+
+module BoxxLoki
+  class RecommendationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # 
+    # Get Recommendations 
+    # @param request_data request data
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse200]
+    def root_post(request_data, opts = {})
+      data, _status_code, _headers = root_post_with_http_info(request_data, opts)
+      return data
+    end
+
+    # 
+    # Get Recommendations 
+    # @param request_data request data
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse200, Fixnum, Hash)>] InlineResponse200 data, response status code and response headers
+    def root_post_with_http_info(request_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RecommendationApi.root_post ..."
+      end
+      # verify the required parameter 'request_data' is set
+      if @api_client.config.client_side_validation && request_data.nil?
+        fail ArgumentError, "Missing the required parameter 'request_data' when calling RecommendationApi.root_post"
+      end
+      # resource path
+      local_var_path = "/"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request_data)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse200')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecommendationApi#root_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end