flipkart_api 0.0.2 → 0.1.0

data/lib/flipkart_api.rb

@@ -1,14 +1,19 @@
+# coding: utf-8
 require "rest-client"
+require "pry"
+require "logger"
 
 class FlipkartApi
 
   ##
   #
   # Initialize object with userid and token to send api calls.
+  # One optional 3rd parameter to specify api version. It is default to v0.1.0.
   #
-  def initialize(fk_userid, fk_token)
+  def initialize(fk_userid, fk_token, version='v0.1.0')
     @api = "https://affiliate-api.flipkart.net/affiliate"
     @header = {"Fk-Affiliate-Id" => fk_userid, "Fk-Affiliate-Token" => fk_token}
+    @version = version
   end
  
   ##
@@ -20,8 +25,8 @@ class FlipkartApi
   #  * fa.get_categories("json")
   #
   def get_categories(format)
-    rest_url="#{@api}/api/#{@header['Fk-Affiliate-Token']}.#{format}"
-    RestClient.get rest_url
+    rest_url="#{@api}/api/#{@header['Fk-Affiliate-Id']}.#{format}"
+    RestClient.get rest_url, @header
   end
 
   ##
@@ -32,8 +37,46 @@ class FlipkartApi
   #  * fa.get_category_porducts_api("bags_wallets_belts")
   # Returns the api to get all the products of the category
   #
-  def get_category_porducts_api(category)
-    JSON.parse(get_categories("json"))["apiGroups"]["affiliate"]["apiListings"][category]["availableVariants"]["v0.1.0"]["get"]
+  def get_category_products_api(category_name)
+    JSON.parse(get_categories("json"))["apiGroups"]["affiliate"]["apiListings"][category_name]["availableVariants"][@version]["get"]
+  end
+
+  ##
+  #
+  # This method will get the api for accessing all the products that have changed after perticular version of a category.
+  # This api is also used to pull the current version.
+  # Usage:
+  #  * fa = FlipkartApi.new(fk_userid, fk_token)
+  #  * fa.get_category_delta_version_api("bags_wallets_belts")
+  # Returns the api of the category to pull the changed products after perticular version.
+  #
+  def get_category_delta_version_api(category_name)
+    JSON.parse(get_categories("json"))["apiGroups"]["affiliate"]["apiListings"][category_name]["availableVariants"][@version]["deltaGet"]
+  end
+
+  ##
+  #
+  # This method will get the current version of a particular category after which products have changed.
+  # Usage:
+  #  * fa = FlipkartApi.new(fk_userid, fk_token)
+  #  * fa.get_category_delta_porducts_api("bags_wallets_belts")
+  # Returns the verstion number of the category
+  #
+  def get_current_delta_version(version_api)
+    JSON.parse(RestClient.get(version_api, @header))['version']
+  end
+  
+  ##
+  # This method will get the api to access all the products that have changed after current version or the version number passed.
+  # Usage:
+  #   * fa = FlipkarApi.new(fk_userid, fk_token)
+  #   * fa.get_category_delta_products_api("bags_wallets_belts")
+  # Returns the api to get products that have changed after perticular version.
+  #
+  def get_category_delta_products_api(category_name, version=nil)
+    version_api = get_category_delta_version_api(category_name)
+    version = get_current_delta_version(version_api) unless version
+    version_api.gsub(".json","/fromVersion/#{version}.json")
   end
 
   ##
@@ -43,10 +86,19 @@ class FlipkartApi
   # Usage:
   #  * fa.get_products_by_category("bags_wallets_belts")
   #
-  def get_products_by_category(category)
-    get_products(get_category_product_api(category))
+  def get_products_by_category(category_name)
+    get_products(get_category_products_api(category_name))
   end
-  
+ 
+  ##
+  #
+  # This method will get the first 500 products in the json parsed data structure.
+  # Usage:
+  #  * fa.get_delta_products_by_category("bags_wallets_belts")
+  #
+  def get_delta_products_by_category(category_name, version=nil)
+    get_products(get_category_delta_products_api(category_name, version))
+  end 
   ##
   #
   # This method will get all the products in the json parsed data structure.
@@ -76,6 +128,46 @@ class FlipkartApi
     json_data = JSON.parse(rest_output)
   end
   
+  ##
+  #
+  # This method will get all the categories list in flipkart with rest url to access books
+  # of that particular category in json or xml format. ("json"/"xml")
+  # Usage:
+  #  * fa = FlipkartApi.new(fk_userid, fk_token)
+  #  * fa.get_books_categories("json")
+  # 
+  def get_book_categories(format)
+    rest_url="#{@api}/1.0/booksApi/#{@header['Fk-Affiliate-Id']}.#{format}"
+    RestClient.get rest_url, @header
+  end
+  
+  ##
+  #
+  # This method will get the api for accessing books of a particular category.
+  # Since flipkart returns categories in tree structure. This method takes parameter in array to find the category in parent child order.
+  # Usage:
+  #  * fa = FlipkartApi.new(fk_userid, fk_token)
+  #  * fa.get_category_books_api(["books", "Fiction & Non-Fiction Books", "Children Books"])
+  # Returns the api to get bookds of the category
+  #
+  def get_category_books_api(categories)
+    json_categories = JSON.parse(get_book_categories("json"))["booksCategory"]
+    return json_categories["url"] if categories.size==1 && categories.first=="Books"
+    categories.drop(1).inject(json_categories){|json_categories, category| json_categories["subCategories"].select{|sub_category| sub_category["name"]==category}.first}["url"]
+  end
+  
+  ##
+  #
+  # This method will get the first 500 books from the given category in the json parsed data structure.
+  # Usage:
+  #  * fa.get_books_by_category(["Books", "Fiction & Non-Fiction Books", "Children Books", "Activity Books", "Cursive Writing"])
+  # Returns the books from 'Cursive Writing' category
+  #
+  def get_books_by_category(categories)
+    rest_output = RestClient.get get_category_books_api(categories), @header
+    JSON.parse(rest_output)
+  end
+  
   ##
   #
   # This method will get the deals of the day in json or xml format.
@@ -92,7 +184,7 @@ class FlipkartApi
   #
   def get_dotd_offers(format)
     rest_url = "#{@api}/offers/v1/dotd/#{format}"
-    RestClient.get rest_url, @header
+    JSON.parse(RestClient.get rest_url, @header)
   end
   
   ##
@@ -111,7 +203,7 @@ class FlipkartApi
   #
   def get_top_offers(format)
     rest_url = "#{@api}/offers/v1/top/#{format}"
-    RestClient.get rest_url, @header
+    JSON.parse(RestClient.get rest_url, @header)
   end
  
   ##
@@ -119,7 +211,7 @@ class FlipkartApi
   # This method will get the full deatials of a particualar product.
   # Output will json or xml depending on format parameter (json, xml)
   # Usage:
-  #  * fa.getproduct_by_id("TVSDD2DSPYU3BFZY", "json")  
+  #  * fa.get_product_by_id("TVSDD2DSPYU3BFZY", "json")  
   #
   def get_product_by_id(product_id, format)
     rest_url = "#{@api}/product/#{format}?id=#{product_id}"
@@ -133,8 +225,8 @@ class FlipkartApi
   #Usage:
   #  * fa.search("product name", "json", 5)
   #
-  def searh(key, formate,  max_result=10)
-    rest_url = "#{@api}/search/format?query=#{key}&resultCount=#{max_result}"
+  def search(key, format,  max_result=10)
+    rest_url = "#{@api}/search/#{format}?query=#{key}&resultCount=#{max_result}"
     RestClient.get rest_url, @header
   end
 

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: flipkart_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Deepak HB
@@ -9,11 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2017-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -21,6 +23,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -35,25 +38,26 @@ files:
 homepage: https://github.com/deepakhb2/flipkart_api
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
-summary: This gem is to pull data from flipkart using flipkart api
+specification_version: 3
+summary: This gem will help you to pull data from flipkart using flipkart api
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 77dcc3556f63ebf346acbf988573222f26babef8
-  data.tar.gz: eddb4114f143194e190a8e3f355effa766ccd4aa
-SHA512:
-  metadata.gz: 50ed98932f42389403a34091cb8da2d56f75e7a5d5f6c0f0a0229f0026bcd4467af0640e7d1f307206c384b6b1f39b79a1d9a6dd5dd419a9766e680b63be90e8
-  data.tar.gz: f07307671dd61939ffa46669f25fba35e6cffc53129df414181924d196f28404dc5a5dcefcb912651d089e107291b7b6d583e59895f56188e24806710e803aad