artifacia 0.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e593e72b1969b6b2813cfadde0a26564e0838df6
-  data.tar.gz: 2033b99eea0485cd06b55a2d5af1b9bd138f3c3e
+  metadata.gz: d0a9d771635e85cd06644d9d778058cdd1a67eab
+  data.tar.gz: 28c4e3d47e5e5b7b8f57627381a2732d028e2d9d
 SHA512:
-  metadata.gz: f6709d77515c3d26f4c5556977c8e8b68da6ee29e5beffc34382d11f41b756f717aafbb36a2fb13d24458fb9bea128e6fb7f874fa65692dc3066c2c4e0aa9b73
-  data.tar.gz: 6584752eaf3cfbd0486991858121a19109c66410cb63f287d8d99f07ddabd82b72cdbcf1decc2b3adb1a0035b2c7e1115f913f73154eb44eb0027fbb1a7b43a3
+  metadata.gz: 5a9a5b651247e60d6c128002fb2ba612ede9ede834ab098307900ede364f0d4990a6a403345c7474608ee51b2b6cf2d63b5bdc469a0e95f34f8e7aab9fafc3e4
+  data.tar.gz: c0e6c4f1941cb54c2e330039299fdb2c9ad0470c19d2505ecabd1ebc7931ed8623c5da577255ac9f397351791275188c5d59d9c384e913abd8a885883031792f

data/README.md

@@ -2,23 +2,23 @@
 
 This ruby client is a simple wrapper around our powerful Visual Discovery [API](http://docs.artifacia.com/).
 
-The wrapper allows you to create your own indexes of images on which you would like to enhance the product discovery experiences. It also allows you to get various types of recommendations which are listed below.
+The wrapper allows you to create your own index of images on which you would like to enhance the product discovery experiences. It also allows you to get various types of recommendations which are listed below.
 
 * Visual Recommendation
 * Cross Product Recommendation
-* Smart Recommendation
+* Personalized Recommendation
 
 ## Installation
 
 To install the package you can follow the steps:-
 
 ```ruby
-rubygem install artifacia
+[sudo] gem install artifacia
 ```
 
 ## Getting Started
 
-The API is really easy and simple to use. First you need to create an account [here]() and there you will get a username and a password. Using that credentials you can create your constructor and get stated. 
+The API is really easy and simple to use. First you need to visit [this](http://www.artifacia.com/requestaccess/) page and request for username and password. Using that credentials you can create your constructor and get stated.
 
 ```ruby
 require 'artifacia'
@@ -28,21 +28,23 @@ client = Client.new(user_name, password)
 ```
 
 ### Creating your index
-The first step is to create a index of the items that you would like to store in our databases to perform search against. If you don't have data ready right now you can quickly get started with our [sample data](). Once the data is stored and indexed we will inform you shortly.
+The first step is to create a index of the items that you would like to store in our databases to perform search against. If you don't have data ready right now you can quickly get started with our [sample data](https://github.com/artifacia/artifacia-client-ruby/blob/master/sample_data.json). Once the data is stored and indexed we will inform you shortly.
 
-```python
-import json
-sample_data = json.load(open("sample_data.json","rb"))
+```ruby
+sample_data = File.read("sample_data.json")
 data_indexing_response = client.upload_item_data(sample_data)
-print data_indexing_response
+puts data_indexing_response
 ```
 
 ### Performing Visual Recommendation
+
 Once you receive a notification form us about the status of the indexed data, you are ready to search.
-You can search for a product ID indexed in the sample data you inserted/uploaded.
+You can search for a product ID indexed in the sample data you inserted/uploaded. And also you can specify the number to results to be returned.
+
 
 ```ruby
 sample_prod_id = 2761
-query_response = client.get_visual_recommendations(sample_prod_id)
+num = 4
+query_response = client.get_visual_recommendation(sample_prod_id, num)
 puts query_response
 ```

data/artifacia.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'artifacia'
-  s.version     = '0.1'
+  s.version     = '0.1.2'
   s.date        = Date.today
   s.summary     = "Artifacia!"
   s.description = "A ruby client to integrate visual recommendation feature from Artifacia API"

data/lib/artifacia.rb

@@ -10,31 +10,35 @@ class Client
     @host = 'api.artifacia.com'
   end
 
-  def upload_user_data(data)
-    @post_ws = "/v1/users"
-    @payload=data
+  def upload_user_purchased_items(user_id, data)
+    @post_ws = "/v1/users/#{user_id}/purchased_items"
+    req = Net::HTTP::Post.new(@post_ws, initheader = {'Content-Type' =>'application/json'})
+         req.basic_auth @user, @pass
+         req.body = data
+         response = Net::HTTP.new(@host).start {|http| http.request(req) }
+    return response.body
+  end
 
+  def upload_user_viewed_items(user_id, data)
+    @post_ws = "/v1/users/#{user_id}/viewed_items"
     req = Net::HTTP::Post.new(@post_ws, initheader = {'Content-Type' =>'application/json'})
          req.basic_auth @user, @pass
-         req.body = @payload
+         req.body = data
          response = Net::HTTP.new(@host).start {|http| http.request(req) }
     return response.body
   end
 
   def upload_item_data(data)
     @post_ws = "/v1/items"
-    @payload=data
-
     req = Net::HTTP::Post.new(@post_ws, initheader = {'Content-Type' =>'application/json'})
          req.basic_auth @user, @pass
-         req.body = @payload
+         req.body = data
          response = Net::HTTP.new(@host).start {|http| http.request(req) }
     return response.body
   end
 
   def delete_item_data(item_ids)
     @post_ws = "/v1/items"
-
     req = Net::HTTP::Delete.new(@post_ws, initheader = {'Content-Type' =>'application/json'})
          req.basic_auth @user, @pass
          req.body = item_ids
@@ -42,24 +46,24 @@ class Client
     return response.body
   end
 
-  def get_visual_recommendation(prod_id)
-    @post_ws = "/v1/recommendation/similar/#{prod_id}"
+  def get_visual_recommendation(prod_id, num)
+    @post_ws = "/v1/recommendation/similar/#{prod_id}/#{num}"
     req = Net::HTTP::Get.new(@post_ws, initheader = {'Content-Type' =>'application/json'})
          req.basic_auth @user, @pass
          response = Net::HTTP.new(@host).start {|http| http.request(req) }
     return response.body
   end
 
-  def get_cpr_recommendation(prod_id)
-    @post_ws = "/v1/recommendation/collections/#{prod_id}"
+  def get_cpr_recommendation(prod_id, num)
+    @post_ws = "/v1/recommendation/collections/#{prod_id}/#{num}"
     req = Net::HTTP::Get.new(@post_ws, initheader = {'Content-Type' =>'application/json'})
          req.basic_auth @user, @pass
          response = Net::HTTP.new(@host).start {|http| http.request(req) }
     return response.body
   end
 
-  def get_smart_recommendation(prod_id)
-    @post_ws = "/v1/recommendation/user/#{prod_id}"
+  def get_personalized_recommendation(user_id, num)
+    @post_ws = "/v1/recommendation/user/#{user_id}/#{num}"
     req = Net::HTTP::Get.new(@post_ws, initheader = {'Content-Type' =>'application/json'})
          req.basic_auth @user, @pass
          response = Net::HTTP.new(@host).start {|http| http.request(req) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artifacia
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.2
 platform: ruby
 authors:
 - Ashish Kumar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-21 00:00:00.000000000 Z
+date: 2016-08-03 00:00:00.000000000 Z
 dependencies: []
 description: A ruby client to integrate visual recommendation feature from Artifacia
   API
@@ -17,9 +17,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/artifacia.rb
-- artifacia.gemspec
 - README.md
+- artifacia.gemspec
+- lib/artifacia.rb
 homepage: https://github.com/artifacia/artifacia-client-ruby
 licenses: []
 metadata: {}
@@ -29,17 +29,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Artifacia!