simply_suggest 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57a9ee50d1b1ef3aaee9e99d59c987064134ff1d
-  data.tar.gz: 68122da2a464064c89b189cc7e940ecd3bb9be5f
+  metadata.gz: 7c78798b5aff267bae7ade50c16084b536ce015f
+  data.tar.gz: a154d4338345e32eb951adc15dbec05392051831
 SHA512:
-  metadata.gz: 7ac137b635018f9bfc7d7bf5d6439e9b858a2701719f9d074e7c0682a2f17420d7166ae43c2ace486edebc7590488e80fcc5d69963dd100c499487475343b88f
-  data.tar.gz: a78ef3bef11be6d3f0ab02d123d376b00cb1417d971ff52edd89094d8014d5e4224be88bf35b95d93e44f290ac8729b64bd54ee1aa4794986a702a347838d650
+  metadata.gz: 315207c8ba09413717422f01e61d39e6b414dc0a9ddcb03a33e425b7fc383c5dbcfc8a888c9c3ebc6f95fe09f1fa641ab1a5da5f527006b2a0ef001ba9a1e1be
+  data.tar.gz: e6c30a30ad6227fb0f35cb09ff8e79d879e290b82c5e9b5fec8a0f2a19a5a7db8cdc1d8c2ba75cc246c962e4ada85beac1fad7060c0caf5c0bdc6c499a203b63

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+
+notifications:
+  email:
+    on_success: change
+    on_failure: always
+
+addons:
+  code_climate:
+    repo_token: 4e890328584d6a68879ecba465a2f7dd164c87e09452bbbec6dcf38b918b5321

data/README.md

@@ -1,6 +1,13 @@
-# BotDetection
+# SimplySuggest
 
-Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+[![Build Status](https://travis-ci.org/SimplySuggest/simply_suggest_ruby.svg?branch=master)](https://travis-ci.org/SimplySuggest/simply_suggest_ruby)
+[![security](https://hakiri.io/github/SimplySuggest/simply_suggest_ruby/master.svg)](https://hakiri.io/github/SimplySuggest/simply_suggest_ruby/master)
+[![Code Climate](https://codeclimate.com/github/SimplySuggest/simply_suggest_ruby/badges/gpa.svg)](https://codeclimate.com/github/SimplySuggest/simply_suggest_ruby)
+
+SimplySuggest implementation for Ruby.
+You need an account at www.simply-suggest.com to use this gem.
+
+Direct API-access to all the methods which are available and several helpers to get things a bit less complex.
 
 ## Installation
 
@@ -16,32 +23,89 @@ Or install it yourself as:
 
 	$ gem install simply_suggest
 
-## Changes
+## Configuration
 
-See the [CHANGELOG.md](CHANGELOG.md) file for details.
+For rails put initialization into config/initializers/simply_suggest.rb
+
+	SimplySuggest.configure do |c|
+      c.secret_key = "YOUR SECRET KEY"
+      c.public_key = "YOUR PUBLIC KEY"
+    end
 
 ## Usage
 
 After installing the GEM you can use within your controllers or helpers the following methods
 
-	# this will return an array of object ids which are related to this object
-	recommendations_for object
+This will return an array of object ids which are related to this object
+	recommendations_for @product
+	# => [1,2,3,4,5]
+
+This will autoload all objects from your database
+
+	recommendations_for @product, load: true
+	# => [Product, Product, Product]
+
+This will return an hash of data which are recommended for the user
+
+	user_recommendations current_user.id
+	# => [{ type: "article", id: 1 }, { type: "product", id: 1 }]
+
+This will autoload the data from your database
+
+	user_recommendations current_user.id, load: true
+	# => [Product, Article, Product]
+	
+This will load the current trending objects
+
+	get_trending_objects "article", load: true
+	# => [Article, Article, Article]
+
+You can use the search api accessing the following method in your controller
 
-	# this will return an hash of data which are recommended for the user
-	user_recommendations user_id
+	search_objects "lorem ipsum", "article", load: true
+	# => { results: [Article, Article, Article], facets: nil, conditions: nil }
+	
+You can specify facet fields
+
+	search_objects "lorem ipsum", "article", load: true, facets: [:category_id]
+	# => { results: [Article, Article, Article], facets: { category_id: { key: 4, doc_count: 2 } }, conditions: nil }
+
+you can set autoload within the config to let load default to true
+
+	SimplySuggest.configure do |c|
+      c.autoload = false
+    end
+
+All helpers will raise a ``SimplySuggest::Error`` if something went wrong so you easily catch them.
 
 ### JavaScript-Implementation
 
-	# to use the javascript tracking methods you need to add this line to your <head> or footer
+to use the javascript tracking methods you need to add this line to your <head> or footer
+
 	<%= simply_suggest_script %>
 
-	# then within the footer you can call this function to get the javascript calls
-	<%= get_tracking_code user_id: unique_user_id, object_id: unique_object_id, object_type: object_type, event: "" %>
+then somewhere on your side you can call this function to get the javascript calls
+
+	<%= get_tracking_code user_id: unique_user_id, object_id: unique_object_id, object_type: object_type, event: "view" %>
+
+available event types are
+
+	:buy
+	:like
+	:dislike
+	:favorite
+	:view
+	:add-to-basket 
+
+You should use the primary key of your user or generate and send a unique user id which is saved to the session or cookie so you send always the same one
+
+## Changes
+
+See the [CHANGELOG.md](CHANGELOG.md) file for details.
 
-## Contributing
+## Contributing to SimplySuggest
 
-1. Fork it ( https://github.com/SimplySuggest/simply_suggest_ruby.git/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+1. Check out the Master
+2. Fork the project.
+3. Start a feature/bugfix branch.
+4. Commit and push until you are happy with your contribution.

data/lib/simply_suggest/api_request.rb

@@ -1,8 +1,20 @@
 module SimplySuggest
   class ApiRequest
     def get url, params = {}, headers = {}
+      execute_request :get, url, params, headers
+    end
+
+    def post url, params = {}, headers = {}
+      execute_request :post, url, params, headers
+    end
+
+    def patch url, params = {}, headers = {}
+      execute_request :patch, url, params, headers
+    end
+
+    def execute_request method, url, params = {}, headers = {}
       begin
-        response = rest_client.get do |request|
+        response = rest_client.send(method) do |request|
           configure_request(url, request: request, params: params, headers: headers)
         end
         parse_response(response.body)
@@ -63,8 +75,8 @@ module SimplySuggest
 
           if parsed_response
             error_to_raise.body = parsed_response
-            error_to_raise.title = parsed_response["title"] if parsed_response["title"]
-            error_to_raise.detail = parsed_response["detail"] if parsed_response["detail"]
+            error_to_raise.error_code = parsed_response["error_code"] if parsed_response["error_code"]
+            error_to_raise.message = parsed_response["message"] if parsed_response["message"]
           end
 
           error_to_raise.status_code = error.response[:status]

data/lib/simply_suggest/configuration.rb

@@ -25,12 +25,24 @@ module SimplySuggest
     # default: simply-suggest.com
     attr_accessor :api_domain
 
+    # Api Domain
+    #
+    # default: simply-suggest.com
+    attr_accessor :domain
+
+    # Autoload objects
+    #
+    # default: false
+    attr_accessor :autoload
+
     def initialize
       @secret_key  = nil
       @public_key  = nil
       @timeout     = 2
       @api_version = "v1"
+      @domain      = "simply-suggest.com"
       @api_domain  = "http://v1.simply-suggest.com"
+      @autoload    = false
     end
   end
 

data/lib/simply_suggest/controller_helper.rb

@@ -8,14 +8,16 @@ module SimplySuggest
     # options : hash [optional]
     #
     def recommendations_for item, options = {}
-      limit     = options.delete(:limit) || 10
-      page      = options.delete(:page)  || 1
+      options = options.reverse_merge(default_options)
+
       klass     = item.is_a?(Hash) ? item.delete(:class) : item.class.to_s.downcase
       object_id = item.is_a?(Hash) ? item.delete(:object_id) : item.id
 
-      data = request_object.object_types.send(klass).object.recommendations.page(page).limit(limit).get(object_id)
-      return [] if data["record_predictions"].blank?
-      data["record_predictions"].map { |d| d["recommendation_id"] }
+      data = request_object.object_types.send(klass).object.recommendations.page(options[:page]).limit(options[:limit]).get(object_id)
+      return [] if data["recommendations"].blank?
+      ids = data["recommendations"].map { |d| d["recommendation_id"] }
+      return item.class.where(id: ids) if options[:load]
+      ids
     end
 
     # returns recommendations for the user_id
@@ -24,22 +26,64 @@ module SimplySuggest
     # options : hash [optional]
     #
     def user_recommendations user_id, options = {}
-      object_type = options.delete(:object_type) || options.delete(:class)
-      limit       = options.delete(:limit) || 10
-      page        = options.delete(:page)  || 1
+      options = options.reverse_merge(default_options)
 
-      if object_type.present?
-        data = request_object.user.send(object_type).recommendations.page(page).limit(limit).get(user_id)
+      if options[:object_type].present?
+        data = request_object.user.send(options[:object_type]).recommendations.page(options[:page]).limit(options[:limit]).get(user_id)
       else
         data = request_object.user.recommendations.page(page).limit(limit).get(user_id)
       end
-      return [] if data["user_predictions"].blank?
-      data["user_predictions"].map { |d| { type: d["object_type"], id: d["recommendation_id"] } }
+      return [] if data["recommendations"].blank?
+      return data["recommendations"].map { |d| d["object_type"].classify.constantize.where(id: d["recommendation_id"]).first }.reject(&:nil?) if options[:load]
+      data["recommendations"].map { |d| { type: d["object_type"], id: d["recommendation_id"] } }
+    end
+
+    # returns trending data for the object type
+    #
+    # klass : string
+    # options : hash [optional]
+    #
+    def get_trending_objects klass, options = {}
+      options = options.reverse_merge(default_options)
+
+      data = request_object.object_type.trending.send(klass).page(page).limit(limit).get
+      return [] if data["trending"].blank?
+      return klass.classify.constantize.where(id: data["trending"].map { |d| d["external_id"] }) if options[:load]
+      data["trending"].map { |d| { type: d["object_type"], id: d["external_id"] } }
+    end
+
+    def search_objects query, klass, options = {}
+      options = options.reverse_merge(default_options)
+
+      request = request_object.object_type.search.send(klass).page(options[:page]).limit(options[:limit]).add_params(query: query)
+      request.add_param(:conditions, options[:conditions]) if options[:conditions].present?
+      request.add_param(:facets, options[:facets]) if options[:facets].present?
+
+      data = request.get
+      return [] if data["objects"].blank?
+      if options[:load]
+        values = {}
+        values[:results]    = data["objects"].map { |d| d["object_type"].classify.constantize.where(id: d["external_id"]).first }.reject(&:nil?)
+        values[:facets]     = data["facets"]
+        values[:conditions] = data["conditions"]
+
+        return values
+      end
+
+      data
     end
 
   protected
     def request_object
       @request_object ||= SimplySuggest::Request.new
     end
+
+    def default_options
+      {
+        limit: 10,
+        page: 1,
+        load: SimplySuggest.config.autoload
+      }
+    end
   end
 end

data/lib/simply_suggest/error.rb

@@ -1,5 +1,5 @@
 module SimplySuggest
   class Error < StandardError
-    attr_accessor :title, :detail, :body, :raw_body, :status_code
+    attr_accessor :error_code, :message, :body, :raw_body, :status_code
   end
 end

data/lib/simply_suggest/request.rb

@@ -25,13 +25,39 @@ module SimplySuggest
       values
     end
 
+    def post *args
+      @path_parts += args.to_a
+      values = api_request.post(path, @params)
+      reset
+      values
+    end
+
+    def patch *args
+      @path_parts += args.to_a
+      values = api_request.patch(path, @params)
+      reset
+      values
+    end
+
     def limit num
-      @params[:limit] = num
+      add_param :limit, num
       self
     end
 
     def page num
-      @params[:page] = num
+      add_param :page, num
+      self
+    end
+
+    def add_param name, value
+      @params[name.to_sym] = value
+      self
+    end
+
+    def add_params params = {}
+      params.each_pair do |name, value|
+        @params[name.to_sym] = value
+      end
       self
     end
 

data/lib/simply_suggest/version.rb

@@ -1,3 +1,3 @@
 module SimplySuggest
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/simply_suggest/view_helper.rb

@@ -11,7 +11,7 @@ module SimplySuggest
       content_tag :script do
         "(function() {
           var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
-          po.src = '//static.#{SimplySuggest.config.domain}/script/v2.js';
+          po.src = '//static.#{SimplySuggest.config.domain}/script/v1.js';
           var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
         })();".html_safe
       end
@@ -34,8 +34,12 @@ module SimplySuggest
       content_tag :script, script
     end
 
+    def track_click source_id, destination, user_id, options = {}
+      track_recommendation_click(source_id, destination.id, destination.class.to_s.downcase, user_id, options)
+    end
+
     def track_recommendation_click source_id, destination_id, user_id, klass, options = {}
-      use_script  = options[:script] == nil ? true : options[:script]
+      use_script = options[:script] == nil ? true : options[:script]
 
       script = "
         window.track_recommendation = window.track_recommendation || [];

data/simply_suggest.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = SimplySuggest::VERSION
   spec.authors       = ["Simply Suggest"]
   spec.email         = ["info@simply-suggest.com"]
-  spec.summary       = %q{Api for www.simply-suggest.com here}
+  spec.summary       = %q{Api for http://www.simply-suggest.com here}
   spec.homepage      = "http://www.simply-suggest.com"
   spec.license       = "MIT"
 
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'actionpack', '~> 3.0.0', '>= 3.0.0'
+  spec.add_dependency 'actionpack', '>= 3.0.0'
   spec.add_dependency 'faraday', "~> 0.9"
   spec.add_dependency 'multi_json', '~> 1.11'
 

data/spec/request_spec.rb

@@ -1,30 +1,43 @@
 require 'spec_helper'
 
 class TestController < ActionController::Base
-  def test1
-    @bot_detector = BotDetection::Detector.new(user_agent: BotDetection::BotUserAgents.first, remote_ip: "127.0.0.1")
-  end
-
-  def test2
-    @bot_detector = BotDetection::Detector.new(user_agent: "Googlebot/2.1 (+http://www.googlebot.com/bot.html)", remote_ip: "66.249.66.1")
-  end
 end
 
 describe "Api::Calls" do
   before {
     SimplySuggest.configure do |c|
-      c.secret_key  = "secret-2"
-      c.public_key  = "public-2"
-      c.api_domain  = "http://v1.recommendation.dev"
+      c.secret_key  = "58f38a8b-ca16-4d44-acc9-0a6f0bf0919f"
+      c.public_key  = "cbb8f914-d89f-49ef-b732-8b0e133f6cb5"
     end
   }
 
   context 'api calls' do
-    it 'check several api methods' do
+    it "creates an object_types and raises an error" do
+      expect { SimplySuggest::Request.object_type.create.add_params(name: "article").post }.to raise_exception(SimplySuggest::Error)
+    end
+
+    it "updates an object_type" do
+      result = SimplySuggest::Request.object_type.update.send("article").add_params(name: "article").patch
+      expect(result["error"]).to eq(false)
+    end
+
+    it "creates an object in the article object type" do
+      expect { SimplySuggest::Request.object_type.send("article").object.create.add_params(object_id: "1").post }.to raise_exception(SimplySuggest::Error)
+    end
+
+    it "updates an object with some data" do
+      result = SimplySuggest::Request.object_type.send("article").object.update.add_params(data: { title: "lorem", description: "test" }).patch(1)
+      expect(result["error"]).to eq(false)
+    end
+
+    it 'checks object type api methods' do
       expect(SimplySuggest::Request.object_types.get.length).to be > 0
       expect(SimplySuggest::Request.object_types.limit(1).get.length).to be == 1
-      expect(SimplySuggest::Request.object_types.album.objects.get.length).to be > 0
-      expect(SimplySuggest::Request.object_types.album.object.recommendations.get(1026).length).to be > 0
+    end
+
+    it "checks object api methods" do
+      expect(SimplySuggest::Request.object_type.article.get.length).to be > 0
+      expect { SimplySuggest::Request.object_types.article.object.recommendations.get(1026) }.to raise_exception(SimplySuggest::Error)
     end
   end
 
@@ -33,15 +46,20 @@ describe "Api::Calls" do
       expect(ActionController::Base.included_modules).to include(SimplySuggest::ControllerHelper)
     end
 
-    it 'should test controller helpers with object recommendations' do
-      expect(TestController.new.recommendations_for(class: "album", object_id: 1026).length).to be > 0
-      expect { TestController.new.recommendations_for(class: "album", object_id: 54684) }.to raise_exception(SimplySuggest::Error)
+    it "tests search methods" do
+      result = TestController.new.search_objects("test", "article")
+      expect(result["objects"].length).to eq(1)
     end
 
-    it 'should test controller helpers with user recommendations' do
-      expect(TestController.new.user_recommendations("ffc0635b-e32b-4a3d-a5b6-2703e08bdc14").length).to be > 0
-      expect(TestController.new.user_recommendations("ffc0635b-e32b-4a3d-a5b6-2703e08bdc14", object_type: "series").length).to be > 0
-      expect(TestController.new.user_recommendations("ffc0635b-e32b-4a3d-a5b6-2703e08bdc14", object_type: "album").length).to be == 0
-    end
+    # it 'should test controller helpers with object recommendations' do
+    #   expect(TestController.new.recommendations_for(class: "article", object_id: 1).length).to be > 0
+    #   expect { TestController.new.recommendations_for(class: "article", object_id: 123) }.to raise_exception(SimplySuggest::Error)
+    # end
+
+    # it 'should test controller helpers with user recommendations' do
+    #   expect(TestController.new.user_recommendations("ffc0635b-e32b-4a3d-a5b6-2703e08bdc14").length).to be > 0
+    #   expect(TestController.new.user_recommendations("ffc0635b-e32b-4a3d-a5b6-2703e08bdc14", object_type: "series").length).to be > 0
+    #   expect(TestController.new.user_recommendations("ffc0635b-e32b-4a3d-a5b6-2703e08bdc14", object_type: "album").length).to be == 0
+    # end
   end
 end

metadata

@@ -1,22 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: simply_suggest
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Simply Suggest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -24,9 +21,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -108,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -147,5 +142,5 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Api for www.simply-suggest.com here
+summary: Api for http://www.simply-suggest.com here
 test_files: []