indix-api-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11cc7291d0e2490961013b4657f583df7c596095
+  data.tar.gz: c4001e25aafaf019f46a26acf91e9ba64c44024b
+SHA512:
+  metadata.gz: eb20938c99608b30516fd9e25772e25986268d76448246fb8cc294351d56cf9e0cc1624437992b09e30a5325eba1cdd506854213932b7fb96d4cd3f4e219f34f
+  data.tar.gz: eca83230a94399a7ef811c3db08777e60a1035906e0e20c7bda7f9e34c24b92fe1b68e9f3ae8a86b9aab2c53cabbde2bf9b9078d944c7a1f52ab53a186e73201

data/lib/exceptions.rb

@@ -0,0 +1,12 @@
+class RuntimeException < StandardError;
+end
+class ResourceNotFound < StandardError;
+end
+class BadRequest < StandardError;
+end
+class UnAuthorizedException < StandardError;
+end
+class RequestTimeoutException < StandardError;
+end
+class ResponseError < StandardError;
+end

data/lib/http_client.rb

@@ -0,0 +1,90 @@
+require 'exceptions'
+require 'rest_client'
+require 'uri'
+require 'hashie'
+require 'active_support'
+
+class HttpClient
+  attr_accessor :host, :protocol, :headers
+  
+  def initialize(host, protocol = 'https')
+    @host = host
+    @protocol = protocol
+    @headers = {}
+  end
+
+  def set_headers(hash)
+    @headers = @headers.merge(hash)
+  end
+
+  def request(method, path, request_params = {}, payload = {}, extra_options = {})
+    response = nil
+    path = url(method, path, request_params)
+    begin
+      case method
+      when 'get'
+        response = self.get(path)
+      when 'post'
+        payload = build_query(payload) if extra_options[:multipart] != true
+        response = self.post(path, payload)
+      end
+    rescue RestClient::BadRequest => e
+      raise BadRequest.new(JSON.parse(e.http_body)["statusMessage"])								
+    rescue RestClient::ResourceNotFound => e
+      raise ResourceNotFound.new(e.message)  
+    rescue RestClient::Unauthorized => e
+      raise UnAuthorizedException.new(e.message)
+    rescue Exception => e
+      raise e
+    end
+
+    unless extra_options[:stream] == true
+      unless response.empty?
+        response = ::ActiveSupport::JSON.decode(response)
+        response = to_hashie(response)
+      end
+    end
+    response
+  end 
+
+  def get(path)
+    RestClient::Request.execute(:method => :get, :url => path, :headers => @headers, :verify_ssl => false)
+  end
+
+  def post(path, data)
+    RestClient::Request.execute(:method => :post, :url => path, :payload => data, :headers => @headers)
+  end
+
+  private
+ 
+  def url(method, path, options = {})
+    query_string = build_query(options)
+    uri_hash = {:host => @host, :path => URI::encode(path), :query => query_string}
+    uri = @protocol == 'http' ? URI::HTTP.build(uri_hash) : URI::HTTPS.build(uri_hash)
+    uri.to_s
+  end
+
+  def escape_string(str)
+    URI.escape(str, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+  end
+
+  def build_query(options)
+    return nil if options.nil? or options.empty?
+    options = options.collect do |name, value|
+      if value.is_a? Array
+        value.collect { |v| "#{name}=#{v.class.to_s != 'Fixnum' ? escape_string(v.to_s) : v}" }.join('&')
+      else
+        "#{name}=#{!value.nil? ? (value.class.to_s != 'Fixnum' ? escape_string(value.to_s) : value) : ''}"
+      end
+    end.join('&')
+    options
+  end 
+  
+  def to_hashie json
+    if json.is_a? Array
+      json.collect! { |x| x.is_a?(Hash) ? Hashie::Mash.new(x) : x }
+    else
+      Hashie::Mash.new(json)
+    end
+  end
+end

data/lib/indix_api_client.rb

@@ -0,0 +1,205 @@
+require 'http_client'
+require 'models'
+
+class IndixApiClient < ParamsBase
+	attr_accessor :app_id, :app_key, :host, :protocol, :http_client, :api_version
+
+	def initialize(app_id, app_key, host = "api.indix.com", protocol = "https")
+		@app_id = app_id
+		@app_key = app_key
+		@host = host
+		@protocol = protocol
+		@http_client = get_http_client
+		@api_version = "v2"
+	end
+
+	def get_stores(query)
+		params = query.to_hash
+		params.merge!(get_api_params)
+		self.http_client.request("get", "/#{self.api_version}/stores", params)		
+	end
+
+	def get_brands(query)
+		params = query.to_hash
+		params.merge!(get_api_params)
+		self.http_client.request("get", "/#{self.api_version}/brands", params)		
+	end
+
+	def get_categories
+		params = self.to_hash
+		self.http_client.request("get", "/#{self.api_version}/categories", params)		
+	end
+
+	def get_summary_products(query)
+		get_products(query, 'summary')
+	end
+
+	def get_offers_standard_products(query)
+		get_products(query, 'offersStandard')
+	end
+
+	def get_offers_premium_products(query)
+		get_products(query, 'offersPremium')
+	end
+
+	def get_catalog_standard_products(query)
+		get_products(query, 'catalogStandard')
+	end
+
+	def get_catalog_premium_products(query)
+		get_products(query, 'catalogPremium')		
+	end
+
+	def get_universal_products(query)
+		get_products(query, 'universal')		
+	end
+
+	def get_summary_product_detail(product_id, countryCode)
+		get_product_detail(product_id, countryCode, 'summary')
+	end
+
+	def get_offers_standard_product_detail(product_id, countryCode)
+		get_product_detail(product_id, countryCode, 'offersStandard')
+	end
+
+	def get_offers_premium_product_detail(product_id, countryCode)
+		get_product_detail(product_id, countryCode, 'offersPremium')
+	end
+
+	def get_catalog_standard_product_detail(product_id, countryCode)
+		get_product_detail(product_id, countryCode, 'catalogStandard')
+	end
+
+	def get_catalog_premium_product_detail(product_id, countryCode)
+		get_product_detail(product_id, countryCode, 'catalogPremium')
+	end				
+
+	def get_universal_product_detail(product_id, countryCode)
+		get_product_detail(product_id, countryCode, 'universal')
+	end
+
+	def post_bulk_summary_products(query)
+		post_bulk_search_job(query, 'summary')
+	end
+
+	def post_bulk_offers_standard_products(query)
+		post_bulk_search_job(query, 'offersStandard')
+	end
+
+	def post_bulk_offers_premium_products(query)
+		post_bulk_search_job(query, 'offersPremium')
+	end
+
+	def post_bulk_catalog_standard_products(query)
+		post_bulk_search_job(query, 'catalogStandard')
+	end
+
+	def post_bulk_catalog_premium_products(query)
+		post_bulk_search_job(query, 'catalogPremium')		
+	end	
+
+	def post_bulk_universal_products(query)
+		post_bulk_search_job(query, 'universal')		
+	end
+
+	def post_bulk_summary_product_lookup(query)
+		post_bulk_lookup_job(query, 'summary')
+	end
+
+	def post_bulk_offers_standard_product_lookup(query)
+		post_bulk_lookup_job(query, 'offersStandard')
+	end
+
+	def post_bulk_offers_premium_product_lookup(query)
+		post_bulk_lookup_job(query, 'offersPremium')
+	end
+
+	def post_bulk_catalog_standard_product_lookup(query)
+		post_bulk_lookup_job(query, 'catalogStandard')
+	end
+
+	def post_bulk_catalog_premium_product_lookup(query)
+		post_bulk_lookup_job(query, 'catalogPremium')		
+	end	
+
+	def post_bulk_universal_product_lookup(query)
+		post_bulk_lookup_job(query, 'universal')		
+	end
+
+	def get_bulk_job_status(job_id)
+		params = get_api_params
+		self.http_client.request("get", "/#{self.api_version}/bulk/jobs/#{job_id}", params)		
+	end	
+
+	def get_bulk_job_output(job_id)
+		params = get_api_params
+		extra_options = {:stream => true}
+		self.http_client.request("get", "/#{self.api_version}/bulk/jobs/#{job_id}/download", params, {}, extra_options)		
+	end	
+
+	def post_advanced_search_bulk_job(query)
+		payload = query.to_hash
+		payload.merge!(get_api_params)
+		extra_options = {:multipart => true}		
+		self.http_client.request("post", "/#{self.api_version}/universal/bulk/ase", {}, payload, extra_options)	
+	end
+
+	def get_advanced_search_bulk_job_status(job_id)
+		params = get_api_params
+		self.http_client.request("get", "/#{self.api_version}/bulk/ase/#{job_id}", params)	
+	end
+
+	def get_advanced_search_bulk_job_output(job_id)
+		params = get_api_params
+		extra_options = {:stream => true}
+		self.http_client.request("get", "/#{self.api_version}/bulk/ase/#{job_id}", params, {}, extra_options)
+	end
+
+	def get_api_params
+		{"app_id" =>  self.app_id, "app_key" => self.app_key}
+	end
+
+	def get_suggestions(country_code, q)
+		params = get_api_params
+		params.merge!({"countryCode" => country_code, "q" => q})
+		self.http_client.request("get", "/#{self.api_version}/bulk/ase/#{job_id}", params)
+	end
+
+	def get_product_price_history(pid, query)
+		params = query.to_hash
+		params.merge!(get_api_params)
+		self.http_client.request("get", "/#{self.api_version}/history/products/#{pid}", params)
+	end
+
+	private
+
+	def get_products(query, type = 'summary')
+		params = query.to_hash
+		params.merge!(get_api_params)
+		self.http_client.request("get", "/#{self.api_version}/#{type}/products", params)		
+	end	
+
+	def get_product_detail(product_id, country_code, type = 'summary')
+		params = {"countryCode" => country_code}
+		params.merge!(get_api_params)
+		self.http_client.request("get", "/#{self.api_version}/#{type}/products/#{product_id}", params)		
+	end	
+
+	def post_bulk_search_job(query, type = 'summary')
+		payload = query.to_hash
+		payload.merge!(get_api_params)
+		self.http_client.request("post", "/#{self.api_version}/#{type}/bulk/products", {}, payload)   				
+	end
+
+	def post_bulk_lookup_job(query, type = 'summary')
+		payload = query.to_hash
+		payload.merge!(get_api_params)
+		extra_options = {:multipart => true}		
+		self.http_client.request("post", "/#{self.api_version}/#{type}/bulk/lookup", {}, payload, extra_options)				
+	end
+
+	def get_http_client
+		HttpClient.new(self.host, self.protocol)
+	end
+
+end

data/lib/models.rb

@@ -0,0 +1,36 @@
+class ParamsBase
+	def initialize params
+    params.each { |k, v| send "#{k}=", v }
+  end
+
+	def to_hash
+		hash = {}
+		self.instance_variables.each do |var| 
+			hash[var.to_s.delete("@")] = self.instance_variable_get(var) 
+		end
+		hash
+	end
+end
+
+class BCSQueryParams < ParamsBase
+	attr_accessor :q
+end
+
+class BulkProductLookupParams < ParamsBase
+	attr_accessor :countryCode, :file
+end
+
+class BulkProductSearchParams < ParamsBase
+	attr_accessor :countryCode, :storeId, :alsoSoldAt, :brandId, :categoryId
+	attr_accessor :startPrice, :endPrice, :availability, :priceHistoryAvailable, :priceChange
+	attr_accessor :onPromotion, :lastRecordedIn, :storesCount, :applyFiltersTo, :selectOffersFrom
+end
+
+class SearchParams < BulkProductSearchParams
+	attr_accessor :q, :url, :upc, :mpn, :sku
+	attr_accessor :sortBy, :facetBy, :pageNumber, :pageSize
+end
+
+class PriceHistoryParams < ParamsBase
+	attr_accessor :countryCode, :storeId
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: indix-api-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeevan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: Indix API Client library to interact with indix apis using ruby
+email: jeevan@indix.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/exceptions.rb
+- lib/http_client.rb
+- lib/indix_api_client.rb
+- lib/models.rb
+homepage: http://indix.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Indix API Client library to interact with indix apis using ruby
+test_files: []