shop_express 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f4f893058662a1ecae75107bb0e5aeadb98a6bf0e42f438c530654e0b5380e8
+  data.tar.gz: a3ceabf6340410701d8c83a32d03852951ebd91fa571d2e3e3c6b2c573f545bd
+SHA512:
+  metadata.gz: 05f5bac4f5e2c110aff3ec6a3096f4606783b15117a201adf5ef6f9ddf016d369766cfa5a59c0a9446da374db54dcb7b614f5cd461935b54f5eefdaaba3e3fb1
+  data.tar.gz: f5e9de20dbd3ae3cb2e219d324fb8fc365d7cfe80814ee2835723e7691f703d33489457ed9f5fb7a69e9276bed32fbd2e36fb822a65b8e9644a31c51e3b04b4a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Denys Krupenov
+
+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,11 @@
+This is gem used for exchange data with shop-express.ua internet shop constructor
+
+Authorization usage, 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* returns all log data without OK status.

data/lib/shop_express/authorization.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'connection'
+
+module ShopExpress
+  # Class for user authorization
+  class Authorization < ::ShopExpress::Base
+    AUTH_URL = '/api/auth/'
+    EXPIRATION_TIME = 600
+
+    def authorize
+      response = post(shop_express: shop_express, url: AUTH_URL, body: body)
+      return response unless response['status'] == 'OK'
+
+      shop_express.token = response.dig('response', 'token')
+      shop_express.expiration_timestamp = Time.now + EXPIRATION_TIME
+      response
+    end
+
+    private
+
+    attr_reader :shop_express
+
+    def body
+      { login: shop_express.login, password: shop_express.password }
+    end
+  end
+end

data/lib/shop_express/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'connection'
+
+module ShopExpress
+  # base class for all methods used in others classes
+  class Base
+    include Connection
+    attr_reader :shop_express
+
+    # @param shop_express [ShopExpress::Client]
+    def initialize(shop_express)
+      @shop_express = shop_express
+    end
+  end
+end

data/lib/shop_express/connection.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'faraday'
+module ShopExpress
+  # Module for check connection
+  module Connection
+    ERROR = { 'status' => 'HTTP_ERROR', 'response' => { 'message' => 'UNKNOWN SERVER ERROR' } }.freeze
+
+    def post(shop_express:, url:, body:, add_token: false)
+      mixin_token!(shop_express, body) if add_token
+      connection(shop_express).post(url, body).body
+    rescue Faraday::Error
+      ERROR
+    end
+
+    def connection(shop_express)
+      @connection ||= Faraday.new(url: shop_express.url) do |faraday|
+        faraday.request :json
+        faraday.response :raise_error
+        faraday.response :json
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def mixin_token!(shop_express, body)
+      shop_express.refresh_token! unless shop_express.token_valid?
+      body[:token] = shop_express.token
+    end
+  end
+end

data/lib/shop_express/import_residues.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+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)
+      body = post(shop_express: shop_express, url: URL, body: body, add_token: true)
+      parse_response(body)
+    end
+
+    private
+
+    def parse_response(body)
+      log = body.dig('response', 'log')
+      return [] unless log
+
+      log.filter { |el| el['status'] != STATUS_OK }
+    end
+  end
+end

data/lib/shop_express.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'shop_express/base'
+require_relative 'shop_express/connection'
+require_relative 'shop_express/authorization'
+require_relative 'shop_express/import_residues'
+
+module ShopExpress
+  # Base class used to store data about authentication
+  class Client
+    attr_accessor :url, :login, :password, :token, :expiration_timestamp
+
+    # @param url [URI]
+    # @param login [String]
+    # @param password [String]
+    def initialize(url:, login:, password:)
+      @url = url
+      @login = login
+      @password = password
+      @token = nil
+      @expiration_timestamp = nil
+    end
+
+    def token_valid?
+      return false if token.nil?
+
+      expiration_timestamp < Time.now
+    end
+
+    def refresh_token!
+      ShopExpress::Authorization.new(self).authorize
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: shop_express
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Denys Krupenov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: Gem for exchange data with the internet shop CMS
+email: dkru84@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/shop_express.rb
+- lib/shop_express/authorization.rb
+- lib/shop_express/base.rb
+- lib/shop_express/connection.rb
+- lib/shop_express/import_residues.rb
+homepage: https://github.com/dkru/shop_express
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: ShopExpress API interface
+test_files: []