suggestgrid 0.1.15.pre.SNAPSHOT

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c02249dab28bb791116722c17977fb33500a9e9a
+  data.tar.gz: da4dcec2787f07bdc245dea3b0fd7c3d8fcf34ed
+SHA512:
+  metadata.gz: afe0eceea0a2a7d9f07c6a30467d5f0aa689baa4d24d436ab31c77f07b78e0845da04e7ffd83a2d18b2e1d64bccfa240a5299a267b0f055632657d276ef558aa
+  data.tar.gz: 016f2caf8052d210ac1e71df72ef7968c7b46525f885d5312c1db4eeaf3026c35c39666b3c20a893e2edcceefb73a6e2e9af520974b90d62183e86206aeb7755

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2016 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,104 @@
+# [ SuggestGrid Ruby Client ]( http://www.github.com/suggestgrid/suggestgrid-ruby )
+
+We will walk through how to get started with SuggestGrid Ruby Client in three steps:
+    
+1. [Configuration](#1-configuration)
+    
+2. [Post actions](#2-post-actions)
+    
+3. [Get recommendations](#3-get-recommendations)
+
+If you did not [sign up for SuggestGrid](https://dashboard.suggestgrid.com/users/sign_up), this is the right time.
+
+## Getting Started
+
+In this guide we will demonstrate how to display personalized recommendations on an existing Ruby project.
+
+We have a movie catalog Ruby application, SuggestGridMovies, similar to IMDb.
+For logged in users we want to display movies that *similar people viewed* on movie pages.
+Let's implement this feature in five minutes with SuggestGrid!
+
+### 1. Configuration
+
+We are beginning the development by adding the client as a dependency:
+
+```ruby
+gem 'suggest_grid', git: 'https://github.com/suggestgrid/suggestgrid-ruby.git'
+```
+
+
+
+Applications make their API requests to their dedicated sub-domain of `suggestgrid.space`.
+
+Most endpoints require a username and password for authentication.
+
+An initial user name and password is given on sign up.
+
+It is very convenient to configure SuggestGrid by setting an authenticated `SUGGESTGRID_URL` environment variable in the format below:
+
+`http://{user}:{pass}@{region}.suggestgrid.space/{app-uuid}`
+
+You can authenticate your application using `SUGGESTGRID_URL` environment variable like the example below:
+
+```ruby
+sg_uri = ENV['SUGGESTGRID_URL']
+
+# Initialize the SuggestGrid client.
+::SuggestGridClient = SuggestGrid::SuggestGridClient.new sg_uri
+```
+
+
+Every recommendation logic needs to belong to a *type*.
+For this demonstration we can create an implicit type named as `views`.
+This could be done either from the dashboard or with a snippet like this:
+
+```ruby
+  begin
+    SuggestGridClient.type.get_type('views')
+    puts "SuggestGrid type named 'views' already exists, skipping creation."
+  rescue SuggestGrid::APIException => e
+    SuggestGridClient.type.create_type('views')
+    puts "SuggestGrid type named 'views' is created."
+  end
+```
+
+
+
+### 2. Post actions
+
+Once the type exists, let's start posting actions.
+We should invoke SuggestGrid client's action.post_action when an user views an item in our application.
+
+We can do this by putting the snippet below on the relevant point:
+
+```ruby
+# Send action to SuggestGrid.
+begin
+  SuggestGridClient.action.post_action(SuggestGrid::Action.new('views',user.id, self.id))
+rescue Exception => e
+  puts "Exception while sending action #{e}"
+end
+```
+
+
+The more actions SuggestGrid gets, more relevant and diverse its responses are.
+
+
+### 3. Get recommendations
+
+Finally, let's show "movies similar users viewed" on movie pages.
+
+SuggestGrid needs *recommendation models* for returning recommendations.
+Model generation is scheduled in every 24 hours.
+In addition, instant model generations can be triggered on the dashboard.
+
+Once the first model generated for 'views' type, recommendations could be get using a snippet like the following:
+
+```ruby
+begin
+  items_response = SuggestGridClient.recommendation.get_recommended_items({type: 'view', user_id: user.id, size: size})
+  items_response.items
+rescue Exception => e
+  puts "Exception while getting recommendations #{e}"
+end
+```

data/lib/suggest_grid/api_helper.rb

@@ -0,0 +1,151 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class APIHelper
+    # Replaces template parameters in the given url
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Array] The parameters to replace in the url
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+
+      # return if there are no parameters to replace
+      if parameters.nil?
+        query_builder
+      else
+        # iterate and append parameters
+        parameters.each do |key, value|
+          replace_value = ''
+
+          if value.nil?
+            replace_value = ''
+          elsif value.instance_of? Array
+            value.map!{|element| CGI.escape(element.to_s)}
+            replace_value = value.join('/')
+          else
+            replace_value = CGI.escape(value.to_s)
+          end
+
+          # find the template parameter and replace it with its value
+          query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+        end
+      end
+      return query_builder
+    end
+
+    # Appends the given set of parameters to the given query string
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Array] The parameters to append
+    def self.append_url_with_query_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+
+      # return if there are no parameters to replace
+      if parameters.nil?
+        return query_builder
+      else
+        # remove any nil values
+        parameters = parameters.reject { |_key, value| value.nil? }
+
+        # does the query string already has parameters
+        has_params = query_builder.include? '?'
+        separator = has_params ? '&' : '?'
+
+        # append query with separator and parameters and return
+        return query_builder << separator << URI.encode_www_form(parameters)
+      end
+    end
+
+    # Validates and processes the given Url
+    # @param [String] The given Url to process
+    # @return [String] Pre-processed Url as string
+    def self.clean_url(url)
+      # perform parameter validation
+      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
+
+      # ensure that the urls are absolute
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # get the http protocol match
+      protocol = matches[1]
+      
+      # check if parameters exist
+      index = url.index('?')
+
+      # remove redundant forward slashes
+      query = url[protocol.length...(index != nil ? index : url.length)]
+      query.gsub!(%r{\/\/+}, '/')
+
+      # get the parameters
+      parameters = index != nil ? url[url.index('?')...url.length] : ""
+
+      # return processed url
+      return protocol + query  + parameters
+    end	
+
+    # Parses JSON string.
+    # @param [String] A JSON string.
+    def self.json_deserialize(json)
+      begin
+        return JSON.parse(json)
+      rescue
+        raise TypeError, "Server responded with invalid JSON."
+      end
+    end
+
+    # Form encodes a hash of parameters.
+    # @param [Hash] The hash of parameters to encode.
+    # @return [Hash] A hash with the same parameters form encoded.
+    def self.form_encode_parameters(form_parameters)
+      encoded = Hash.new
+      form_parameters.each do |key, value|
+        encoded.merge!(APIHelper.form_encode value, key)
+      end 
+      return encoded
+    end
+
+    # Form encodes an object.
+    # @param [Dynamic] An object to form encode.
+    # @param [String] The name of the object.
+    # @return [Hash] A form encoded representation of the object in the form of a hash.
+    def self.form_encode(obj, instance_name)
+      retval = Hash.new
+
+      # If this is a structure, resolve it's field names.
+      if obj.respond_to? :key_map
+        obj = obj.key_map
+      end
+      
+      # Create a form encoded hash for this object.
+      if obj == nil
+        nil         
+      elsif obj.instance_of? Array
+        obj.each_with_index do |value, index|
+          retval.merge!(APIHelper.form_encode(value, instance_name + "[" + index.to_s + "]"))
+        end
+      elsif obj.instance_of? Hash
+        obj.each do |key, value|
+          retval.merge!(APIHelper.form_encode(value, instance_name + "[" + key + "]"))
+        end
+      else
+        retval[instance_name] = obj
+      end
+      return retval
+    end
+  end
+end
+
+# extend types to support to_bool
+module ToBoolean
+  def to_bool
+    return true if self == true || self.to_s.strip =~ /^(true|yes|y|1)$/i
+    return false
+  end
+end
+
+class NilClass; include ToBoolean; end
+class TrueClass; include ToBoolean; end
+class FalseClass; include ToBoolean; end
+class Numeric; include ToBoolean; end
+class String; include ToBoolean; end

data/lib/suggest_grid/configuration.rb

@@ -0,0 +1,21 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class Configuration
+    # The base Uri for API calls
+    @base_uri = 'http://localhost:9090'
+
+    # The username to use with basic authentication
+    @basic_auth_user_name = 'TODO: Replace'
+
+    # The password to use with basic authentication
+    @basic_auth_password = 'TODO: Replace'
+
+    # create the getters and setters
+    class << self
+      attr_accessor :base_uri
+      attr_accessor :basic_auth_user_name
+      attr_accessor :basic_auth_password
+    end
+  end
+end

data/lib/suggest_grid/controllers/action_controller.rb

@@ -0,0 +1,257 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class ActionController < BaseController
+    @@instance = ActionController.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # Get Actions
+    # @param [String] type Optional parameter: The type of the actions.
+    # @param [String] user_id Optional parameter: The user id of the actions.
+    # @param [String] item_id Optional parameter: The item id of the actions.
+    # @param [String] older_than Optional parameter: Delete all actions of a type older than the given timestamp or time. Valid times are 1s, 1m, 1h, 1d, 1M, 1y, or unix timestamp (like 1443798195).
+    # @return CountResponse response from the API call
+    def get_actions(type = nil,
+                    user_id = nil,
+                    item_id = nil,
+                    older_than = nil)
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/v1/actions'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'type' => type,
+        'user_id' => user_id,
+        'item_id' => item_id,
+        'older_than' => older_than
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'SUGGESTGRID',
+        'accept' => 'application/json'
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
+
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Endpoint error handling using HTTP status codes.
+      if _response.status_code == 400
+        raise APIException.new '400 - Required `user_id` or `item_id` parameters are missing from the request body.', _context
+      elsif _response.status_code == 429
+        raise APIException.new '429 - Too many requests.', _context
+      elsif _response.status_code == 500
+        raise APIException.new '500 - Unexpected internal error.', _context
+      end
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      return CountResponse.from_hash(decoded)
+    end
+
+    # Post an Action
+    # @param [Action] body Required parameter: The action to be posted.
+    # @return MessageResponse response from the API call
+    def post_action(body)
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/v1/actions'
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'SUGGESTGRID',
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers, parameters: body.to_json, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
+
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Endpoint error handling using HTTP status codes.
+      if _response.status_code == 400
+        raise APIException.new '400 - Required `user_id` or `item_id` parameters are missing from the request body.', _context
+      elsif _response.status_code == 402
+        raise APIException.new '402 - Action limit exceeded.', _context
+      elsif _response.status_code == 404
+        raise APIException.new '404 - Type does not exists.', _context
+      elsif _response.status_code == 429
+        raise APIException.new '429 - Too many requests.', _context
+      elsif _response.status_code == 500
+        raise APIException.new '500 - Unexpected internal error.', _context
+      end
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      return MessageResponse.from_hash(decoded)
+    end
+
+    # Delete Actions
+    # @param [String] type Optional parameter: The type of the actions.
+    # @param [String] user_id Optional parameter: The user id of the actions.
+    # @param [String] item_id Optional parameter: The item id of the actions.
+    # @param [String] older_than Optional parameter: Delete all actions of a type older than the given timestamp or time. Valid times are 1s, 1m, 1h, 1d, 1M, 1y, or unix timestamp (like 1443798195).
+    # @return MessageResponse response from the API call
+    def delete_actions(type = nil,
+                       user_id = nil,
+                       item_id = nil,
+                       older_than = nil)
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/v1/actions'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'type' => type,
+        'user_id' => user_id,
+        'item_id' => item_id,
+        'older_than' => older_than
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'SUGGESTGRID',
+        'accept' => 'application/json'
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.delete _query_url, headers: _headers, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
+
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Endpoint error handling using HTTP status codes.
+      if _response.status_code == 400
+        raise APIException.new '400 - Required `user_id` or `item_id` parameters are missing from the request body.', _context
+      elsif _response.status_code == 404
+        raise APIException.new '404 - Type does not exists.', _context
+      elsif _response.status_code == 422
+        raise APIException.new '422 - No query parameter (`user_id`, `item_id`, or `older_than`) is given.  In order to delete all actionsdelete the type.', _context
+      elsif _response.status_code == 429
+        raise APIException.new '429 - Too many requests.', _context
+      elsif _response.status_code == 500
+        raise APIException.new '500 - Unexpected internal error.', _context
+      end
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      return MessageResponse.from_hash(decoded)
+    end
+
+    # Post Bulk Actions
+# @param [Collection] actions Required parameter: List of actions to be posted.
+    # @return MessageResponse response from the API call
+    def post_bulk_actions(actions)
+        body = ''
+        actions.each do |action|
+            body += "#{action.to_json}\n"
+        end
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/v1/actions/_bulk'
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'SUGGESTGRID',
+        'accept' => 'application/json',
+        'content-type' => 'text/plain; charset=utf-8'
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers, parameters: body, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
+
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Endpoint error handling using HTTP status codes.
+      if _response.status_code == 402
+        raise APIException.new '402 - Action limit exceeded.', _context
+      elsif _response.status_code == 429
+        raise APIException.new '429 - Too many requests.', _context
+      elsif _response.status_code == 500
+        raise APIException.new '500 - Unexpected internal error.', _context
+      end
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      return MessageResponse.from_hash(decoded)
+    end
+  end
+end

data/lib/suggest_grid/controllers/base_controller.rb

@@ -0,0 +1,20 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class BaseController
+    attr_accessor :http_client, :http_call_back
+
+    @@http_client = UnirestClient.new
+
+    def initialize(http_client: nil, http_call_back: nil)
+      @http_client = http_client ||= @@http_client
+      @http_call_back = http_call_back
+    end
+
+    def validate_response(context)			
+      if !context.response.status_code.between?(200, 208) #[200,208] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', context
+      end
+    end
+  end
+end