flipkart_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfdcfc98743a0e17e28f182ee90ceb022fdf75a7
-  data.tar.gz: cb709b62d0298a269b3a82b998dfee165978c524
+  metadata.gz: 77dcc3556f63ebf346acbf988573222f26babef8
+  data.tar.gz: eddb4114f143194e190a8e3f355effa766ccd4aa
 SHA512:
-  metadata.gz: acd1c1b250aaf7d32ce5dd050fd98f1d52b422a722f08c10f6ecfb78dd11b0cad1280121a6ff7c71e17889569b91ce156e542ca8e9ed291efa397e96af0e51a9
-  data.tar.gz: 71b6b3c29b530d7a99b9c22f179fa0228803086de1c222dd6f223f596b0ca15d9aea8b39cdfc2447c06a2af4848c6b79e034abb06ffbf6adad336e940cd7b988
+  metadata.gz: 50ed98932f42389403a34091cb8da2d56f75e7a5d5f6c0f0a0229f0026bcd4467af0640e7d1f307206c384b6b1f39b79a1d9a6dd5dd419a9766e680b63be90e8
+  data.tar.gz: f07307671dd61939ffa46669f25fba35e6cffc53129df414181924d196f28404dc5a5dcefcb912651d089e107291b7b6d583e59895f56188e24806710e803aad

data/lib/flipkart_api.rb

@@ -1,45 +1,153 @@
 require "rest-client"
 
 class FlipkartApi
+
+  ##
+  #
+  # Initialize object with userid and token to send api calls.
+  #
   def initialize(fk_userid, fk_token)
     @api = "https://affiliate-api.flipkart.net/affiliate"
     @header = {"Fk-Affiliate-Id" => fk_userid, "Fk-Affiliate-Token" => fk_token}
   end
-  
-  def get_categories
-    format="json"
+ 
+  ##
+  #
+  # This method will get all the categories list in flipkart with rest url to access products
+  # of that particular category in json or xml format. ("json"/"xml")
+  # Usage:
+  #  * fa = FlipkartApi.new(fk_userid, fk_token)
+  #  * fa.get_categories("json")
+  #
+  def get_categories(format)
     rest_url="#{@api}/api/#{@header['Fk-Affiliate-Token']}.#{format}"
     RestClient.get rest_url
   end
-  
+
+  ##
+  #
+  # This method will get the api for accessing all the products of a particular category.
+  # Usage:
+  #  * fa = FlipkartApi.new(fk_userid, fk_token)
+  #  * 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"]
+  end
+
+  ##
+  #
+  # This method will get the first 500 products in the json parsed data structure.
+  # Output will also contain "nextUrl" which inturn returns next 500 products.
+  # Usage:
+  #  * fa.get_products_by_category("bags_wallets_belts")
+  #
   def get_products_by_category(category)
-    rest_url = JSON.parse(get_categories)["apiGroups"]["affiliate"]["apiListings"][category]["availableVariants"]["v0.1.0"]["get"]
-    get_all_products(rest_url)
+    get_products(get_category_product_api(category))
   end
   
+  ##
+  #
+  # This method will get all the products in the json parsed data structure.
+  # The parameter is the output of get_category_products_api("bags_wallets_belts")
+  # Usage:
+  #  * fa.get_all_products(rest_url)
+  #
   def get_all_products(rest_url)
-    rest_output = RestClient.get rest_url, @header
-    all_products = [rest_output]
-    json_data = JSON.parse(rest_output)
+    json_arr = []
+    json_data = get_products rest_url
+    json_arr << [json_data]
     while json_data["nextUrl"]
-      rest_output = RestClient.get json_data["nextUrl"], @header
-      all_products<<[rest_output]
-      json_data = JSON.parse(rest_output)
+      json_data = get_products json_data["nextUrl"]
+      json_arr << [json_data]
     end
+    jsonout = json_arr.to_json
+  end
+
+  ##
+  #
+  # This method will get the first 500 products from the given rest api in the json parsed data structure.
+  # Usage:
+  #  * fa.get_products(rest_url)
+  #
+  def get_products(rest_url)
+    rest_output = RestClient.get rest_url, @header
+    json_data = JSON.parse(rest_output)
   end
   
+  ##
+  #
+  # This method will get the deals of the day in json or xml format.
+  # Usage:
+  #  * fa.get_dotd_offes("json")  Can accept "xml" .
+  # 
+  # Output
+  # Details on dotdList:
+  #  * title - Title of the offer
+  #  * description - Description about the offer
+  #  * url - URL for the offer
+  #  * imageUrls - List of Image URLs corresponding to the Offer
+  #  * availability - Either “In-stock” / “Out-of-stock” about the products with offer.
+  #
   def get_dotd_offers(format)
     rest_url = "#{@api}/offers/v1/dotd/#{format}"
     RestClient.get rest_url, @header
   end
   
+  ##
+  #
+  # This method will get the top offers in xml or json format
+  # Usage:
+  #  * fa.get_top_offers("json")  Can accept "xml".
+  #
+  # Output:
+  # Details on topOffersList:
+  #  * title - Title of the offer
+  #  * description - Description about the offer
+  #  * url - URL for the offer
+  #  * imageUrls - List of Image URLs corresponding to the Offer
+  #  * availability - Either “In-stock” / “Out-of-stock” about the products with offer.
+  #
   def get_top_offers(format)
     rest_url = "#{@api}/offers/v1/top/#{format}"
     RestClient.get rest_url, @header
   end
-  
-  def get_product_by_id(product_id)
-    rest_url = "#{@api}/product/json?id=#{product_id}"
+ 
+  ##
+  #
+  # 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")  
+  #
+  def get_product_by_id(product_id, format)
+    rest_url = "#{@api}/product/#{format}?id=#{product_id}"
+    RestClient.get rest_url, @header
+  end
+
+  ##
+  #
+  #This method will get all the products accross those matches the key sent as parameters.
+  #Output will be json or xml depending on the parameter passed.
+  #Usage:
+  #  * fa.search("product name", "json", 5)
+  #
+  def searh(key, formate,  max_result=10)
+    rest_url = "#{@api}/search/format?query=#{key}&resultCount=#{max_result}"
+    RestClient.get rest_url, @header
+  end
+
+  ##
+  #
+  # This method will get all the orders of perticular status. Output will be json or xml depending on parameter
+  # Usage:
+  #  * fa.orders_report("yyyy-MM-dd", "yyyy-MM-dd", "Pending", "json")
+  #
+  # status = Pending/Approved/Cancelled/Disapproved
+  #
+  def orders_report(start_date, end_date, status, format, offset=0)
+    rest_url = "#{@api}/report/orders/detail/#{format}?startDate=#{start_date}&endDate=#{end_date}&status=#{status}&offset=#{offset}"
     RestClient.get rest_url, @header
   end
 end

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: flipkart_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Deepak HB
+- Girish Nair
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -51,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: This gem is to pull data from flipkart using flipkart api