sage_world 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcb4b99fb543e5ee93f2d56470fb7c4b5672315b17cf38ea49982890fc9f5b13
+  data.tar.gz: 406cf8b2f6d3e1d3a736cdcbca3d9ec281f3af38ea305c66e14a0fdf819732df
+SHA512:
+  metadata.gz: 9c4279ae9ddc891e2cc9de3603aac221d23365d9fd77a7f91fcdb1f715cdccdf6fc959c6eabb856e3aac5b29eb6516ef1cf28bca57407b38e7f4aaca2e0fd15f
+  data.tar.gz: 9fe3145ed1b1fccbdefadb345d579facdd7eb440681ee4b2740295263c0aa6e43eecc96b8d93126d42dad38b75fcb1e5f9319223ff6cc7aa37823f3b54a07d76

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/Gemfile.lock
+/*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at abhishek.kanojia@vinsol.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sage_world.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Abhishek Kanojia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,272 @@
+# SageWorld
+
+SageWorld provides an easier way to use sageworld api in rails application.
+https://www.sageworld.com/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sage_world', '~> 0.1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sage_world
+
+  ### #Installation
+  Run `rails g sage_world:install` to generate sage_world initializer file.
+  This will generate `config/initializer/sage_world_initializer.rb` which contains the following code.
+  ```ruby
+    SageWorld.config do |config|
+        # Sage Account ID
+        config.account_id = ENV['sage_api_account']
+        # Sage Login
+        config.login = ENV['sage_api_login']
+        # Sage Password
+        config.password = ENV['sage_api_password']
+        # Sage Api Version
+        config.version = ENV['sage_api_version']
+        # Sage End Point
+        config.end_point = ENV['sage_api_end_point']
+        # Optional Logging
+        config.log_data = true # logs request response to log/sage_world.log
+     end
+  ```
+
+### #Usage
+SageWorld provides operations on following entities.
+- Category List - Available product categories.
+- Suppliers List - Available suppliers.
+- Supplier Details - Supplier details.
+- Products Search - Search product
+- Product Details - Product details
+- Product Theme List - Available Product themes
+
+### Category List
+```ruby
+response = SageWorld::Api::CategoryList.get
+# default result is sorted by name.
+# Sorting Results
+
+## Sort-By name
+response = SageWorld::Api::CategoryList.get({ sort: "name"})
+
+## Sort-By category number
+response = SageWorld::Api::CategoryList.get({ sort: "catnum"})
+```
+
+### Supplier List
+
+```ruby
+response = SageWorld::Api::SupplierList.get
+# default result is sorted by name.
+# Sorting Results
+# Supplier list can be sorted by sageid, company or line
+
+## Sort-By sage_id
+response = SageWorld::Api::SupplierList.get({ sort: "sageid" })
+
+## Sort-By company
+response = SageWorld::Api::SupplierList.get({ sort: "company" })
+
+# Sort-By line
+response = SageWorld::Api::SupplierList.get({ sort: "line" })
+
+# AllLines => if set to 1 will return AllLines with every supplier
+response = SageWorld::Api::SupplierList.get({ alllines: 1 })
+```
+
+### Supplier Details
+
+```ruby
+supplier = SageWorld::Api::Supplier.new(supplier_id)
+response = supplier.details
+response.body => { product_details: { ..} }
+
+# Options
+
+# ExtraReturnFields => specifies additional fields to be returned. If you would like to return the general information for a supplier, then include GENINFO in this field. Otherwise leave it blank.
+
+supplier = SageWorld::Api::Supplier.new("22")
+e.g response = supplier.details({ extra_return_fields: "geninfo" })
+```
+
+
+### Product Search
+
+```ruby
+# Keyword for searching is mandatory.
+#
+response = SageWorld::Api::Product.search("mug", { })
+response.body #=> returns hash response.
+
+# Searching Options
+# Basic searching can be combined with multiple options available to narrow down the searching scope.
+# Following are the options that can be used along with searching.
+
+
+# Categories => string
+    # by category name
+    response = SageWorld::Api::Product.search("Ceramic mug", { categories: "Mugs" })
+
+    # by category number
+    response = SageWorld::Api::Product.search("Ceramic mug", { categories: "232" })
+
+# Keywords => string
+    # Every product has some product keywords. searching can be narrowed down using keywords
+    response = SageWorld::Api::Product.search("Ceramic mug", { categories: "Mugs", keywords: "Tshirt" })
+
+
+# Themes => string
+    # Every product has some product theme associated to it.
+    response = SageWorld::Api::Product.search("Ceramic mug", { categories: "Mugs", themes: "Household" })
+
+
+# SPC => string
+    # Search by SPC
+    response = SageWorld::Api::Product.search("Ceramic mug", { categories: "Mugs", themes: "Household", spc: "ISUP-SJKHS" })
+
+  # ItemNum => string
+   # Search by ItemNum
+   response = SageWorld::Api::Product.search("Ceramic mug", { categories: "Mugs", themes: "Household", item_num: "5000" })
+
+  # ItemName => string
+    # Search by ItemName
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug" })
+
+  # PriceLow => currency
+    # Search by Lowest Price in USD ( US dollars )
+   response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", price_low: 2 })
+
+  # PriceHigh => currency
+    # Search by Highest Price in USD ( US dollars )
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", price_high: 2 })
+
+  # Qty => integer
+    # Search by Quantity
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", qty: 2 })
+
+  # Verified => bool
+    # whether product is verified
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", verified: true })
+
+  # Recyclable => 0 or 1
+    # whether product is recyclable
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", recyclable: 0 })
+
+  # EnvFriendly => 0 or 1
+    # whether product is Environment Friendly
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", env_friendly: 1 })
+
+  # NewProduct => 0 or 1
+    # whether product is a new product
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", new_product: 1 })
+
+  # UnionShop => 0 or 1
+    # whether product is a new product
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", union_shop: 1 })
+
+  # ProdTime => integer
+    # Minimumproduction timein working days or '0' forany
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", prod_time: 1 })
+
+  # MadeIn => string
+    # Countrymadein. Blankforall or two-digitcountrycode
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", made_in: "us" })
+
+  # LineName => string
+    # Specific Supplier'sLine Name
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", line_name: "Sunset Hill Stoneware" })
+
+  # Sort => "Blank", "PRICE", "PRICEHIGHLOW", "BESTMATCH", "POPULARITY", "PREFGROUPS"
+   # Blank: Indicates thatthe defaultsortwill be used (as specified in WebStore Settings)
+   # PRICE: Pricesortingin lowestto highest order.
+   # PRICEHIGHLOW: Pricesortingin highestto lowest order.
+   # BESTMATCH: Sort bythe bestmatch based on thecriteria.
+   # POPULARITY: Sorttheitems in terms of popularity, with most popular first.
+   # PREFGROUP: Sort by preferencegroups.
+
+   response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", sort: "PRICE" })
+
+  # ExtraReturnFields => Comma separated fields name
+   # Return additional fields in theresponsestring
+
+   # Can be from the following :
+     # "itemnum" - will return the product’s actual item number.
+     # "category" - will return the productcategory name.
+     # "description" - will return the description for the item.
+     # "colors" - will return thecolor options for the item.
+     # "themes" - will return the themes for the item.
+     # "netprices" - will return theextended price information, including net pricing, published (catalog) pricing and published.
+     # "suppid" - will return the supplier’s Sage.
+     # "line" - will return the line name.
+     # "company" - will return the company name of the supplier.
+     # "prodtime" - will return the production timefor the item.
+
+    e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", extra_return_fields: "description, themes, prodtime" })
+
+  # StartNum => integer && MaxRecs => integer
+    # Record number to startwith (1=FIRST) &  MaxRecs => Maxrecords to return per page
+
+    # The StartNumand MaxRecs fieldsare used to return asubset of thetotalsearch results. Thisallowsyou to implement“records
+    # per page”functionality. Ifyou do notwish to usethesefields, leave both empty. However, ifyou do wantto usethis functionality,
+    # the StartNumshould contain thestartingrecord number for this requestand the MaxRecs should contain the number of records
+    # to return.Forexample, ifasearch returns110total productsand you would liketo displayrecords1-20,you would enter “1”for
+    # StartNumand “20”for MaxRecs. Then, to showrecords21-40,enter “21”as the StartNumand “20”again for MaxRecs.
+
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", start_num: 1, max_recs: 20 })
+
+  # MaxTotalItems => integer
+    # Maxitems to find (<=1000)
+    response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", max_total_items: 100 })
+```
+
+### Product Details
+
+```ruby
+    product = SageWorld::Api::Product.new("Product_id_or_spc")
+    response = product.details
+    response.body # => returns hash having details of product.
+```
+
+### Product Theme List
+
+```ruby
+ # Get Product theme list.
+response = SageWorld::Api::ProductThemeList.get # => return SageWorld::ResponseHandler object.
+response.body #=> { .. }
+```
+
+### Hash details finder
+The api response is going to be hash which can be accessed directly via using hash[:key] or for every key that is defined there is a method defined on `response` object which makes it easier to get to nested field.
+```ruby
+For Example:
+response # =>
+{
+ Response: {
+   "CategoryList": {
+       "Category": ['category 1', 'category2']
+   }
+ }
+}
+
+response.category #=> ['category 1', 'category2']
+response.category_list #=>
+# {
+#   "Category": ['category 1', 'category2']
+#  }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vinsol/sageworld-catalog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sage_world"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/sage_world/install_generator.rb

@@ -0,0 +1,26 @@
+module SageWorld
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      def create_initializer_file
+        create_file "config/initializers/sage_world_initializer.rb", <<~FILE
+          SageWorld.config do |config|
+            # Sage Account ID
+            config.account_id = ENV['sage_api_account']
+            # Sage Login
+            config.login = ENV['sage_api_login']
+            # Sage Password
+            config.password = ENV['sage_api_password']
+            # Sage Api Version
+            config.version = ENV['sage_api_version']
+            # Sage End Point
+            config.end_point = ENV['sage_api_end_point']
+            # Optional Logging
+            config.log_data = true # logs request response to log/sage_world.log
+          end
+        FILE
+      end
+
+    end
+  end
+end

data/lib/sage_world.rb

@@ -0,0 +1,21 @@
+require "sage_world/auth"
+require "sage_world/client"
+require "sage_world/constants"
+require "sage_world/configuration"
+require "sage_world/request"
+require "sage_world/version"
+Gem.find_files("sage_world/**/**/*.rb").each { |path| require path }
+require "sage_world/response_handler"
+
+module SageWorld
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.config
+    @configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+end

data/lib/sage_world/api/base.rb

@@ -0,0 +1,7 @@
+module SageWorld
+  module Api
+    class Base
+
+    end
+  end
+end

data/lib/sage_world/api/category_list.rb

@@ -0,0 +1,38 @@
+module SageWorld
+  module Api
+    class CategoryList < SageWorld::Api::Base
+    # Usage:
+
+    # Without params:
+
+      # response = SageWorld::Api::CategoryList.get => return SageWorld::ResponseHandler object.
+      # On SageWorld::ResponseHandler object one can call following methods depending upon requirements.
+        # response.body => returns the response in hash format.
+
+    # With params:
+
+      # Sorting results
+      # Category list can be sorted by Category Name or Category Number.
+      # By Default Category list is sorted by Name.
+      # response = SageWorld::Api::CategoryList.get({ sort: "name"}) => sorts category list by name
+      # response = SageWorld::Api::CategoryList.get({ sort: "catnum"}) => sorts category list by category number
+
+      def self.get(params = {})
+        if @existing_params == params
+          @response
+        else
+          @existing_params = params
+          response = SageWorld::Client.new(list_builder(params)).send_request
+          @response = SageWorld::ResponseHandler.new(response)
+        end
+      end
+
+      private_class_method def self.list_builder(params)
+        {
+          category_list: params
+        }
+      end
+
+    end
+  end
+end

data/lib/sage_world/api/concerns/find_helper.rb

@@ -0,0 +1,31 @@
+module SageWorld
+  module Api
+    module FindHelper
+
+      module InstanceMethods
+        # SageWorld Api provides helper method on SageWorld::ResponseHandler
+        # which can return the key in nested hash or array and return its value.
+        #
+        # e.g response = SageWorld::Api::Product.search("mugs")
+        # Find in hash provides an easy way to do
+        # response.body[:xml_data_stream_response][:search_results][:items][:item] => simplifies to
+        # response.find_in_hash("Item") => returns array of items.
+
+        def find_in_hash(lookup_key, haystack = body)
+          if haystack.respond_to?(:key?) && haystack.key?(lookup_key)
+            haystack[lookup_key]
+          elsif haystack.respond_to?(:each)
+            data = nil
+            haystack.find{ |*nested_haystack| data = find_in_hash(lookup_key, nested_haystack.last) }
+            data
+          end
+        end
+      end
+
+      def self.included(klass)
+        klass.send(:include, InstanceMethods)
+      end
+    end
+  end
+end
+

data/lib/sage_world/api/product.rb

@@ -0,0 +1,184 @@
+# Summary
+  # Sage world product api provides you 2 basic operations for
+  # => search -> returns collection of searched products.
+  # => details -> return details of product.
+
+module SageWorld
+  module Api
+    class Product < SageWorld::Api::Base
+
+      DEFAULT_SEARCH_PARAMS = {
+        quick_search: ''
+      }.freeze
+
+      def initialize(product_id)
+        @product_id = product_id
+      end
+
+      # Product Details
+      # Usage:
+      # product = SageWorld::Api::Product.new("Product_id_or_spc")
+      # response = product.details
+      # response.body => product details as hash
+
+      def details(options = {})
+        if @existing_options == options
+          @response
+        else
+          @existing_options = options
+          response = SageWorld::Client.new(find_product_params(@product_id ,options)).send_request
+          @response = SageWorld::ResponseHandler.new(response)
+        end
+      end
+
+      # Search
+      #
+      # Usage:
+      #
+      # Keyword for searching is mandatory.
+      #
+      # response = SageWorld::Api::Product.search("mug", { })
+      # response.body => returns hash response.
+
+      # Searching Options
+      # Basic searching can be combined with multiple options available to narrow down the searching scope.
+      # Following are the options that can be used along with searching.
+      #
+
+      # Categories => string
+        # by category name
+          # e.g response = SageWorld::Api::Product.search("Ceramic mug", { categories: "Mugs" })
+
+        # by category number
+          # e.g response = SageWorld::Api::Product.search("Ceramic mug", { categories: "232" })
+
+      # Keywords => string
+        # Every product has some product keywords. searching can be narrowed down using keywords
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { categories: "Mugs", keywords: "Tshirt" })
+
+      # Themes => string
+        # Every product has some product theme associated to it.
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { categories: "Mugs", themes: "Household" })
+
+      # SPC => string
+        # Search by SPC
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { categories: "Mugs", themes: "Household", spc: "ISUP-SJKHS" })
+
+      # ItemNum => string
+       # Search by ItemNum
+       # e.g response = SageWorld::Api::Product.search("Ceramic mug", { categories: "Mugs", themes: "Household", item_num: "5000" })
+
+      # ItemName => string
+        # Search by ItemName
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug" })
+
+      # PriceLow => currency
+        # Search by Lowest Price in USD ( US dollars )
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", price_low: 2 })
+
+      # PriceHigh => currency
+        # Search by Highest Price in USD ( US dollars )
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", price_high: 2 })
+
+      # Qty => integer
+        # Search by Quantity
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", qty: 2 })
+
+      # Verified => bool
+        # whether product is verified
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", verified: true })
+
+      # Recyclable => 0 or 1
+        # whether product is recyclable
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", recyclable: 0 })
+
+      # EnvFriendly => 0 or 1
+        # whether product is Environment Friendly
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", env_friendly: 1 })
+
+      # NewProduct => 0 or 1
+        # whether product is a new product
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", new_product: 1 })
+
+      # UnionShop => 0 or 1
+        # whether product is a new product
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", union_shop: 1 })
+
+      # ProdTime => integer
+        # Minimumproduction timein working days or '0' forany
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", prod_time: 1 })
+
+      # MadeIn => string
+        # Countrymadein. Blankforall or two-digitcountrycode
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", made_in: "us" })
+
+      # LineName => string
+        # Specific Supplier'sLine Name
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", line_name: "Sunset Hill Stoneware" })
+
+      # Sort => "Blank", "PRICE", "PRICEHIGHLOW", "BESTMATCH", "POPULARITY", "PREFGROUPS"
+       # Blank: Indicates thatthe defaultsortwill be used (as specified in WebStore Settings)
+       # PRICE: Pricesortingin lowestto highest order.
+       # PRICEHIGHLOW: Pricesortingin highestto lowest order.
+       # BESTMATCH: Sort bythe bestmatch based on thecriteria.
+       # POPULARITY: Sorttheitems in terms of popularity, with most popular first.
+       # PREFGROUP: Sort by preferencegroups.
+
+       # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", sort: "PRICE" })
+
+      # ExtraReturnFields => Comma separated fields name
+       # Return additional fields in theresponsestring
+
+       # Can be from the following :
+         # "itemnum" - will return the product’s actual item number.
+         # "category" - will return the productcategory name.
+         # "description" - will return the description for the item.
+         # "colors" - will return thecolor options for the item.
+         # "themes" - will return the themes for the item.
+         # "netprices" - will return theextended price information, including net pricing, published (catalog) pricing and published.
+         # "suppid" - will return the supplier’s Sage.
+         # "line" - will return the line name.
+         # "company" - will return the company name of the supplier.
+         # "prodtime" - will return the production timefor the item.
+
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", extra_return_fields: "description, themes, prodtime" })
+
+      # StartNum => integer && MaxRecs => integer
+        # Record number to startwith (1=FIRST) &  MaxRecs => Maxrecords to return per page
+
+        # The StartNumand MaxRecs fieldsare used to return asubset of thetotalsearch results. Thisallowsyou to implement“records
+        # per page”functionality. Ifyou do notwish to usethesefields, leave both empty. However, ifyou do wantto usethis functionality,
+        # the StartNumshould contain thestartingrecord number for this requestand the MaxRecs should contain the number of records
+        # to return.Forexample, ifasearch returns110total productsand you would liketo displayrecords1-20,you would enter “1”for
+        # StartNumand “20”for MaxRecs. Then, to showrecords21-40,enter “21”as the StartNumand “20”again for MaxRecs.
+
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", start_num: 1, max_recs: 20 })
+
+      # MaxTotalItems => integer
+        # Maxitems to find (<=1000)
+        # e.g response = SageWorld::Api::Product.search("Ceramic mug", { pr_name: "13 Ceramic Mug", max_total_items: 100 })
+
+      def self.search(keyword, options = {})
+        options[:quick_search] = keyword
+        params = DEFAULT_SEARCH_PARAMS.merge(options)
+        response = SageWorld::Client.new(search_product_params(params)).send_request
+        SageWorld::ResponseHandler.new(response)
+      end
+
+      private def find_product_params(product_id, options)
+        {
+          product_detail: {
+            product_id: product_id
+          }
+        }.merge(options)
+      end
+
+      private_class_method def self.search_product_params(params)
+        {
+          search: params
+        }
+      end
+
+    end
+  end
+end

data/lib/sage_world/api/product_theme_list.rb

@@ -0,0 +1,30 @@
+module SageWorld
+  module Api
+    class ProductThemeList < SageWorld::Api::Base
+
+    # Usage:
+
+    # response = SageWorld::Api::ProductThemeList.get => return SageWorld::ResponseHandler object.
+
+    # On SageWorld::ResponseHandler object one can call following methods depending upon requirements.
+      # response.body => returns the response in hash format.
+
+      def self.get(params = {})
+        if @existing_params == params
+          @response
+        else
+          @existing_params = params
+          response = SageWorld::Client.new(list_builder(params)).send_request
+          @response = SageWorld::ResponseHandler.new(response)
+        end
+      end
+
+      private_class_method def self.list_builder(params)
+        {
+          theme_list: params
+        }
+      end
+
+    end
+  end
+end

data/lib/sage_world/api/supplier.rb

@@ -0,0 +1,42 @@
+module SageWorld
+  module Api
+    class Supplier < SageWorld::Api::Base
+
+      def initialize(supplier_id)
+        @supplier_id = supplier_id
+      end
+
+      # Example Usage:
+      #
+      # supplier = SageWorld::Api::Supplier.new("222")
+      # response = supplier.details
+        # response.body => details as hash
+      #
+      #
+      #  Options
+        # ExtraReturnFields => specifies additional fields to be returned. If you would like to return the general information for a supplier,
+        #                       then include GENINFO in this field. Otherwise leave it blank.
+        #  supplier = SageWorld::Api::Supplier.new("22")
+        #  e.g response = supplier.details({ extra_return_fields: "geninfo" })
+
+      def details(options = {})
+        if @existing_options == options
+          @response
+        else
+          @existing_options = options
+          response = SageWorld::Client.new(find_supplier_params(@supplier_id, options)).send_request
+          @response = SageWorld::ResponseHandler.new(response)
+        end
+      end
+
+      private def find_supplier_params(supplier_id, options)
+        {
+          supplier_info: {
+            supp_id: supplier_id
+          }
+        }.merge(options)
+      end
+
+    end
+  end
+end

data/lib/sage_world/api/supplier_list.rb

@@ -0,0 +1,41 @@
+module SageWorld
+  module Api
+    class SupplierList < SageWorld::Api::Base
+
+      # Example Usage:
+      #
+      # response = SageWorld::Api::SupplierList.get()
+        # response.body => list as hash
+
+      #
+      # Options
+      #
+        # Sorting
+        # Supplier list can be sorted by sageid, company or line
+        # e.g response = SageWorld::Api::SupplierList.get({ sort: "sageid" })
+        # sort by company response = SageWorld::Api::SupplierList.get({ sort: "company" })
+        # sort by line response = SageWorld::Api::SupplierList.get({ sort: "line" })
+
+      # AllLines => if set to 1 will return AllLines with every supplier
+      # e.g response = SageWorld::Api::SupplierList.get({ alllines: 1 })
+      #
+
+      def self.get(params = {})
+        if @existing_params == params
+          @response
+        else
+          @existing_params = params
+          response = SageWorld::Client.new(list_builder(params)).send_request
+          @response = SageWorld::ResponseHandler.new(response)
+        end
+      end
+
+      private_class_method def self.list_builder(params)
+        {
+          supplier_list: params
+        }
+      end
+
+    end
+  end
+end

data/lib/sage_world/auth.rb

@@ -0,0 +1,65 @@
+require 'gyoku'
+
+module SageWorld
+  class Auth
+
+    attr_reader :request_body
+
+    def initialize(params)
+      validate_configuration
+      @login_id   = SageWorld.configuration.login
+      @password   = SageWorld.configuration.password
+      @version    = SageWorld.configuration.version
+      @account_id = SageWorld.configuration.account_id
+      @params = params
+    end
+
+    def to_xml
+      if request_body
+        Gyoku.xml(request_body, key_converter: lambda { |key| key.camelize(:upper) })
+      end
+    end
+
+    def request_body
+      { XML_data_stream_request: body[:XML_data_stream_request].merge(@params) }
+    end
+
+    private def body
+      {
+        XML_data_stream_request: {
+          version: @version,
+          auth: {
+            acct_id: @account_id,
+            login_id: @login_id,
+            password: @password
+          }
+        }
+      }
+    end
+
+    private def validate_configuration
+      check_configuration_presence
+      check_end_point_presence
+      check_credentials_presence
+      check_account_presence
+    end
+
+    private def check_configuration_presence
+      raise SageWorld::InvalidConfigurationError.new unless SageWorld.configuration.present?
+    end
+
+    private def check_end_point_presence
+      raise SageWorld::InvalidConfigurationError.new(SageWorld::Constants::END_POINT_MISSING_ERROR) unless SageWorld.configuration.end_point
+    end
+
+    private def check_credentials_presence
+      raise SageWorld::InvalidConfigurationError.new(SageWorld::Constants::INVALID_CREDENTIALS) unless SageWorld.configuration.login
+      raise SageWorld::InvalidConfigurationError.new(SageWorld::Constants::INVALID_CREDENTIALS) unless SageWorld.configuration.password
+    end
+
+    private def check_account_presence
+      raise SageWorld::InvalidConfigurationError.new(SageWorld::Constants::ACCOUNT_ID_MISSING_ERROR) unless SageWorld.configuration.account_id
+    end
+
+  end
+end

data/lib/sage_world/client.rb

@@ -0,0 +1,17 @@
+module SageWorld
+  class Client
+
+    def initialize(builder)
+      @request = SageWorld::Request.new(builder)
+    end
+
+    def send_request
+      @request.make_request
+    end
+
+    private def http
+      @request.http
+    end
+
+  end
+end

data/lib/sage_world/configuration.rb

@@ -0,0 +1,7 @@
+module SageWorld
+  class Configuration
+
+    attr_accessor :account_id, :login, :password, :end_point, :version, :log_data
+
+  end
+end

data/lib/sage_world/constants.rb

@@ -0,0 +1,12 @@
+module SageWorld
+  module Constants
+
+    ROOT_KEY = 'XMLDataStreamResponse'
+    ERROR_KEY = 'ErrMsg'
+
+    END_POINT_MISSING_ERROR = 'SageWorld: End point missing in configuration.'
+    INVALID_CREDENTIALS = 'SageWorld: Invalid Login Id or Password in configuration.'
+    ACCOUNT_ID_MISSING_ERROR = 'SageWorld: Account id missing in configuration.'
+
+  end
+end

data/lib/sage_world/exceptions/general_exception.rb

@@ -0,0 +1,11 @@
+module SageWorld
+  class GeneralError < StandardError
+
+    DEFAULT_MESSAGE = 'Error occured while fetching data.'
+
+    def initialize(message = DEFAULT_MESSAGE)
+      super
+    end
+
+  end
+end

data/lib/sage_world/exceptions/invalid_configuration_error.rb

@@ -0,0 +1,11 @@
+module SageWorld
+  class InvalidConfigurationError < StandardError
+
+    INVALID_CONFIGURATION = 'SageWorld configuration not found.'.freeze
+
+    def initialize(message = INVALID_CONFIGURATION)
+      super
+    end
+
+  end
+end

data/lib/sage_world/request.rb

@@ -0,0 +1,48 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module SageWorld
+  class Request
+
+    attr_reader :url, :connection
+
+    def initialize(params)
+      @params = params
+      @auth ||= SageWorld::Auth.new(params)
+      @url ||= URI(SageWorld.configuration.end_point)
+    end
+
+    private def make_connection
+      @connection ||= Faraday.new(@url) do |builder|
+
+        builder.response :xml, :content_type => /\bxml$/
+
+        builder.response :json, :content_type => /\bjson$/
+
+        builder.response :xml, :content_type => /\bhtml$/
+
+        # Enable logging if enabled
+        if SageWorld.configuration.log_data
+          builder.response :logger, ::Logger.new("#{Rails.root}/log/sage_world.log"), bodies: true do |logger|
+            logger.filter(/(\<LoginId\>)(\w+)/,'\1[REMOVED]')
+            logger.filter(/(\<Password\>)(\w+)/,'\1[REMOVED]')
+            logger.filter(/(\<AcctId\>)(\w+)/,'\1[REMOVED]')
+          end
+        end
+
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+    def make_request
+      @connection ||= make_connection
+
+      if @connection
+        @connection.post do |request|
+          request.body = @auth.to_xml
+        end
+      end
+    end
+
+  end
+end

data/lib/sage_world/response_handler.rb

@@ -0,0 +1,29 @@
+module SageWorld
+  class ResponseHandler
+
+    include SageWorld::Api::FindHelper
+
+    attr_reader :response
+
+    def initialize(response)
+      validate_response(response)
+      @response = response
+    end
+
+    def body
+      @response.body.with_indifferent_access
+    end
+
+    def method_missing(method_name)
+      key_name = method_name.to_s.camelize
+      find_in_hash(key_name)
+    end
+
+    private def validate_response(response)
+      if response.body[SageWorld::Constants::ROOT_KEY].key?(SageWorld::Constants::ERROR_KEY)
+        raise SageWorld::GeneralError.new(response.body[SageWorld::Constants::ROOT_KEY][SageWorld::Constants::ERROR_KEY])
+      end
+    end
+
+  end
+end

data/lib/sage_world/version.rb

@@ -0,0 +1,3 @@
+module SageWorld
+  VERSION = "0.1.1"
+end

data/sage_world.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sage_world/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sage_world"
+  spec.version       = SageWorld::VERSION
+  spec.authors       = ["Abhishek Kanojia", "Vinsol Team"]
+  spec.email         = ["abhishek.kanojia@vinsol.com", "info@vinsol.com"]
+
+  spec.summary       = %q{Ruby Wrapper for SageWorld catalog api.}
+  spec.description   = %q{Ruby Wrapper for SageWorld catalog.}
+  spec.homepage      = "https://github.com/vinsol/sageworld-catalog"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'multi_xml'
+  spec.add_dependency 'gyoku', '>= 1.3.1'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: sage_world
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Abhishek Kanojia
+- Vinsol Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gyoku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+description: Ruby Wrapper for SageWorld catalog.
+email:
+- abhishek.kanojia@vinsol.com
+- info@vinsol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/sage_world/install_generator.rb
+- lib/sage_world.rb
+- lib/sage_world/api/base.rb
+- lib/sage_world/api/category_list.rb
+- lib/sage_world/api/concerns/find_helper.rb
+- lib/sage_world/api/product.rb
+- lib/sage_world/api/product_theme_list.rb
+- lib/sage_world/api/supplier.rb
+- lib/sage_world/api/supplier_list.rb
+- lib/sage_world/auth.rb
+- lib/sage_world/client.rb
+- lib/sage_world/configuration.rb
+- lib/sage_world/constants.rb
+- lib/sage_world/exceptions/general_exception.rb
+- lib/sage_world/exceptions/invalid_configuration_error.rb
+- lib/sage_world/request.rb
+- lib/sage_world/response_handler.rb
+- lib/sage_world/version.rb
+- sage_world.gemspec
+homepage: https://github.com/vinsol/sageworld-catalog
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Ruby Wrapper for SageWorld catalog api.
+test_files: []