shop_express 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f4f893058662a1ecae75107bb0e5aeadb98a6bf0e42f438c530654e0b5380e8
-  data.tar.gz: a3ceabf6340410701d8c83a32d03852951ebd91fa571d2e3e3c6b2c573f545bd
+  metadata.gz: 130730098a5790e13912632ad714ab719fc8063fbb3f70daa1eda8553ea88c31
+  data.tar.gz: 5bfd59df810e1256ef25ca0a2425c549212259903f10ffc5aaeceb74cbec5850
 SHA512:
-  metadata.gz: 05f5bac4f5e2c110aff3ec6a3096f4606783b15117a201adf5ef6f9ddf016d369766cfa5a59c0a9446da374db54dcb7b614f5cd461935b54f5eefdaaba3e3fb1
-  data.tar.gz: f5e9de20dbd3ae3cb2e219d324fb8fc365d7cfe80814ee2835723e7691f703d33489457ed9f5fb7a69e9276bed32fbd2e36fb822a65b8e9644a31c51e3b04b4a
+  metadata.gz: 37c3bde3127497796fdb8f8a050049085eebd6fdbecb9a08ed684e6ef055209fd84bac0668cb8cd3b1b9abca7c67efebd1785702bd5d00ff57df2c746a51ecc7
+  data.tar.gz: cb2367f193e284bb7867c260d4141e49166684d2d3fb5117eb4c16c3f21f733b5c928ae9482b7175ffe4e885c3e448e071109a2642462d5182cf0b660326e96e

data/README.md

@@ -1,11 +1,24 @@
-This is gem used for exchange data with shop-express.ua internet shop constructor
+This is gem used for exchange data with https://shop-express.ua - internet shop constructor
 
-Authorization usage, at first you must create instance of class ShopExpress with valid params to connect
+### Authorization 
+At first, you must create instance of class ShopExpress with valid params to connect
 After that you just use instance shop_express for all next requests.
 
     shop_express = ShopExpress::Client.new(url: URI.parse('http://somesite.org'), username: 'jhon', password: 'piterson')
-    
     ShopExpress::Authotization.new(shop_express).authorize
-    ShopExpress::ImportResidues.new(shop_express).import(hash)
+    
+
+### ImportResidues 
+Send returns all log data without OK status.
+```ruby 
+ShopExpress::ImportResidues.new(shop_express).call(hash)
+```
 
-*ImportResidues* returns all log data without OK status.
+### CatalogExport 
+Returns all products in the catalog. Possible arguments:
+- limit (default 5000)
+- offset (default: 0)
+- display_in_show_case ("true" - only goods with quantity > 0, "false" all goods)
+```ruby
+ShopExpress::CatalogExport.new(shop_express).call(limit: 100, offset: 5)
+```

data/lib/shop_express/base.rb

@@ -8,6 +8,8 @@ module ShopExpress
     include Connection
     attr_reader :shop_express
 
+    STATUS_OK = 'OK'
+
     # @param shop_express [ShopExpress::Client]
     def initialize(shop_express)
       @shop_express = shop_express

data/lib/shop_express/catalog_export.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ShopExpress
+  # get list of the products from the shop_express
+  class CatalogExport < ::ShopExpress::Base
+    URL = 'api/catalog/export'
+
+    # @param limit [Integer]
+    # @param offset [Integer]
+    # @param display_in_show_case [String] possible values (false, true)
+    def call(limit: 5000, offset: 0, display_in_show_case: 'false')
+      request_body = {
+        limit: limit,
+        offset: offset,
+        display_in_showcase: display_in_show_case
+      }
+
+      response_body = post(shop_express: shop_express, url: URL, body: request_body, add_token: true)
+      parse_response(response_body)
+    end
+
+    private
+
+    def parse_response(body)
+      return [] if body['status'] != STATUS_OK
+
+      body.dig('response', 'products')
+    end
+  end
+end

data/lib/shop_express/import_residues.rb

@@ -4,7 +4,6 @@ module ShopExpress
   # import_residues to the shop_express
   class ImportResiduences < ::ShopExpress::Base
     URL = 'api/catalog/importResidues/'
-    STATUS_OK = 'OK'
 
     # @param body [Hash]
     def call(body)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shop_express
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Denys Krupenov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-26 00:00:00.000000000 Z
+date: 2025-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -35,6 +35,7 @@ files:
 - lib/shop_express.rb
 - lib/shop_express/authorization.rb
 - lib/shop_express/base.rb
+- lib/shop_express/catalog_export.rb
 - lib/shop_express/connection.rb
 - lib/shop_express/import_residues.rb
 homepage: https://github.com/dkru/shop_express