beyond_api 0.17.0.pre → 0.20.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 121cdb5fc26eaefb6eb20ccad546c70508ed15517e159227b973ab95333ec30f
-  data.tar.gz: 42bc3c28f1696e588c2ed9cd405e32ddee90b2d716299d9354773f70b18613dd
+  metadata.gz: '084d3533192827ae43bcbbdcef706d5e6a3fd9ab7c518492c87dcf57e2ff8233'
+  data.tar.gz: e28b3a3526b2a97eb511137acf723345512dadcaa9fd7532990245ef0846d572
 SHA512:
-  metadata.gz: fbd457331b5d3939a81590f983eb27e2c0ef754f8d4f5cb75c25299d4fd0db0f0c206766463f3918542ef74c3db652a7f5a2b61c677addb63071091c0ed8a397
-  data.tar.gz: 659cc4f40f38f5f36c4c0ab476720cb1a1fc7ef1a6d518b7f0d5f71d8ad3219983e8304c07c5ad8c28d20d0baa2d0225ffe0c6b8324f575f43b0f14fbc3bffb0
+  metadata.gz: 25f33bb7cefa616071fb0b29bbf1c9a104eeb963407e58049a61ee80d9fa93e920859350129c6c398160e357b2de0fb3c9bbf2da4aac63c61cfeccf5f2154e5c
+  data.tar.gz: ca5922134ab627f9fa3482e4a4b367bd0b1252df4a15f6536045b5390518876c597dbedeca3738c51c16402d7dafdf67bc314c3e995398d421d1d7dca0bde74d

data/.env.template

@@ -0,0 +1,3 @@
+CLIENT_ID=""
+CLIENT_SECRET=""
+SHOP_URL=""

data/.rubocop.yml

@@ -0,0 +1,35 @@
+require:
+  - rubocop-ordered_methods
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - spec/**/*.rb
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Layout/LineLength:
+  IgnoredPatterns: ['(\A|\s)#']
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+### v0.20.0.pre
+
+* features
+  * Add product search method
+    * `Products#search`
+
+### v0.19.0.pre
+
+* features
+  * Upload multiple images for products and variations
+
+### v0.18.2.pre
+
+* bug-fixes
+  * Move `#products.update_reserve_stock` from `POST` to `PUT`.
+
+* enhancements
+  * Update how `api_url` is set on `BeyondApi::Session`.
+
+* features
+  * Install, configure and fix most of the Rubocop issues.
+
+### v0.18.1.pre
+
+* bug-fixes
+  * Prevent logging `code` and `refresh_token` on `/api/token` calls.
+
+### v0.18.0.pre
+
+* features
+  * Add new token retrieval/refresh methods
+    * `Token#authorization_code`
+    * `Token#refresh_token`
+    * `Token#client_credentials`
+  * Add alias methods for avoiding deprecation
+    * `refresh` -> `refresh_token`
+    * `create`  -> `authorization_code`
+
 ### v0.17.0.pre
 
 * enhancements

data/Gemfile

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in beyond_api.gemspec
 gemspec
 
 gem "pry"
+
+group :test do
+  gem "factory_bot"
+end

data/Gemfile.lock

@@ -1,28 +1,61 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.17.0.pre)
-      faraday (~> 0.15)
+    beyond_api (0.20.0.pre)
+      faraday (~> 1.8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     dotenv (2.7.6)
-    faker (2.18.0)
+    factory_bot (6.2.0)
+      activesupport (>= 5.0.0)
+    faker (2.19.0)
       i18n (>= 1.6, < 2)
-    faraday (0.17.4)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    i18n (1.8.10)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
+    minitest (5.14.4)
     multipart-post (2.1.1)
+    parallel (1.21.0)
+    parser (3.0.3.1)
+      ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rainbow (3.0.0)
     rake (10.5.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -35,8 +68,31 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    yard (0.9.26)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-ordered_methods (0.9)
+      rubocop (>= 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -45,11 +101,15 @@ DEPENDENCIES
   beyond_api!
   bundler (~> 2.0)
   dotenv (~> 2.7)
+  factory_bot
   faker (~> 2.2)
   pry
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 1.20)
+  rubocop-ordered_methods (~> 0.9)
+  rubocop-rspec (~> 2.4)
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.1.4
+   2.2.31

data/Rakefile

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 YARD::Rake::YardocTask.new do |t|
- t.files   = ['lib/**/*.rb']
+  t.files = ["lib/**/*.rb"]
 end

data/beyond_api.gemspec

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "beyond_api/version"
 
@@ -11,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Ruby client to access the Beyond API"
   spec.homepage      = "https://github.com/ePages-de/beyond_api-ruby_client"
 
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
@@ -20,12 +21,15 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.5.1"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake",    "~> 10.0"
-  spec.add_development_dependency "rspec",   "~> 3.0"
-  spec.add_development_dependency "yard",    "~> 0.9"
-  spec.add_development_dependency "faker",   "~> 2.2"
-  spec.add_development_dependency "dotenv",  "~> 2.7"
+  spec.add_development_dependency "bundler",                 "~> 2.0"
+  spec.add_development_dependency "dotenv",                  "~> 2.7"
+  spec.add_development_dependency "faker",                   "~> 2.2"
+  spec.add_development_dependency "rake",                    "~> 10.0"
+  spec.add_development_dependency "rspec",                   "~> 3.0"
+  spec.add_development_dependency "rubocop",                 "~> 1.20"
+  spec.add_development_dependency "rubocop-ordered_methods", "~> 0.9"
+  spec.add_development_dependency "rubocop-rspec",           "~> 2.4"
+  spec.add_development_dependency "yard",                    "~> 0.9"
 
-  spec.add_dependency "faraday", "~> 0.15"
+  spec.add_dependency "faraday", "~> 1.8.0"
 end

data/bin/console

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "dotenv/load"
 require "beyond_api"
 
-unless ENV["CLIENT_ID"].nil? and ENV["CLIENT_SECRET"].nil?
+unless ENV["CLIENT_ID"].nil? && ENV["CLIENT_SECRET"].nil?
   BeyondApi.setup do |config|
     config.client_id = ENV["CLIENT_ID"]
     config.client_secret = ENV["CLIENT_SECRET"]

data/lib/beyond_api/connection.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'faraday'
+require "faraday"
 
 module BeyondApi
   class Connection
@@ -13,8 +13,8 @@ module BeyondApi
         faraday.options[:timeout] = BeyondApi.configuration.timeout.to_i
         faraday.response :logger, LOGGER, { headers: BeyondApi.configuration.log_headers,
                                             bodies: BeyondApi.configuration.log_bodies }
-        faraday.headers['Accept'] = 'application/json'
-        faraday.headers['Content-Type'] = 'application/json'
+        faraday.headers["Accept"] = "application/json"
+        faraday.headers["Content-Type"] = "application/json"
         faraday.request(:multipart)
         faraday.request(:url_encoded)
         faraday.adapter(:net_http)
@@ -26,11 +26,22 @@ module BeyondApi
         faraday.options[:open_timeout] = BeyondApi.configuration.open_timeout.to_i
         faraday.options[:timeout] = BeyondApi.configuration.timeout.to_i
         faraday.response :logger, LOGGER, { headers: BeyondApi.configuration.log_headers,
-                                            bodies: BeyondApi.configuration.log_bodies }
+                                            bodies: BeyondApi.configuration.log_bodies } do |logger|
+          logger.filter(/(code=)([a-zA-Z0-9]+)/, '\1[FILTERED]')
+          logger.filter(/(refresh_token=)([a-zA-Z0-9.\-\_]+)/, '\1[FILTERED]')
+        end
         faraday.headers['Accept'] = 'application/json'
         faraday.adapter(:net_http)
-        faraday.basic_auth(BeyondApi.configuration.client_id,
-                           BeyondApi.configuration.client_secret)
+        faraday.request :basic_auth, BeyondApi.configuration.client_id, BeyondApi.configuration.client_secret
+      end
+    end
+
+    def self.multipart
+      Faraday.new(ssl: { verify: true }) do |faraday|
+        faraday.options[:open_timeout] = BeyondApi.configuration.open_timeout.to_i
+        faraday.options[:timeout] = BeyondApi.configuration.timeout.to_i
+        faraday.request :multipart, { flat_encode: true }
+        faraday.adapter Faraday.default_adapter
       end
     end
   end

data/lib/beyond_api/error.rb

@@ -5,15 +5,15 @@ module BeyondApi
     attr_reader :error_id, :details, :trace_id, :full_message, :status_code, :error, :error_description
 
     def initialize(data, status_code = nil)
-      @error_id          = data['errorId']
-      @details           = data['details']
-      @trace_id          = data['traceId']
-      @error             = data['error']
-      @error_description = data['error_description']
+      @error_id          = data["errorId"]
+      @details           = data["details"]
+      @trace_id          = data["traceId"]
+      @error             = data["error"]
+      @error_description = data["error_description"]
       @full_message      = data
       @status_code       = status_code
 
-      super(data['message'] || data['error_description'])
+      super(data["message"] || data["error_description"])
     end
   end
 end

data/lib/beyond_api/ext.rb

@@ -5,13 +5,13 @@ class Hash
     result = {}
     each do |key, value|
       result[yield(key)] = case value
-      when Hash
-        value.deep_transform_keys(&block)
-      when Array
-        value.camelize_keys
-      else
-        value
-      end
+                           when Hash
+                             value.deep_transform_keys(&block)
+                           when Array
+                             value.camelize_keys
+                           else
+                             value
+                           end
     end
     result
   end
@@ -31,19 +31,19 @@ class String
   end
 
   def underscore
-    self.gsub(/::/, '/').
-    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-    gsub(/([a-z\d])([A-Z])/,'\1_\2').
-    tr("-", "_").
-    downcase
+    gsub(/::/, "/")
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .tr("-", "_")
+      .downcase
   end
 
   def camelize(uppercase_first_letter = true)
     string = self
     if uppercase_first_letter
-      string = string.sub(/^[a-z\d]*/) { |match| match.capitalize }
+      string = string.sub(/^[a-z\d]*/, &:capitalize)
     else
-      string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { |match| match.downcase }
+      string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/, &:downcase)
     end
     string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub("/", "::")
   end
@@ -53,8 +53,8 @@ class Array
   def camelize_keys
     map do |elem|
       case elem
-        when Hash, Array; elem.camelize_keys
-        else; elem
+      when Hash, Array then elem.camelize_keys
+      else; elem
       end
     end
   end

data/lib/beyond_api/request.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "json"
+require "faraday"
+require "beyond_api/utils"
 
 module BeyondApi
   class Request
@@ -9,7 +11,7 @@ module BeyondApi
         define_method(method) do |session, path, params = {}|
           response = BeyondApi::Connection.default.send(method) do |request|
             request.url(session.api_url + path)
-            request.headers['Authorization'] = "Bearer #{ session.access_token }" unless session.access_token.nil?
+            request.headers["Authorization"] = "Bearer #{session.access_token}" unless session.access_token.nil?
             request.params = params.to_h.camelize_keys
           end
 
@@ -21,7 +23,7 @@ module BeyondApi
         define_method(method) do |session, path, body = {}, params = {}|
           response = BeyondApi::Connection.default.send(method) do |request|
             request.url(session.api_url + path)
-            request.headers['Authorization'] = "Bearer #{ session.access_token }" unless session.access_token.nil?
+            request.headers["Authorization"] = "Bearer #{session.access_token}" unless session.access_token.nil?
             request.params = params.to_h.camelize_keys
             request.body = body.camelize_keys.to_json
           end
@@ -34,8 +36,8 @@ module BeyondApi
     def self.upload(session, path, file_binary, content_type, params)
       response = BeyondApi::Connection.default.post do |request|
         request.url(session.api_url + path)
-        request.headers['Authorization'] = "Bearer #{ session.access_token }" unless session.access_token.nil?
-        request.headers['Content-Type'] = content_type
+        request.headers["Authorization"] = "Bearer #{session.access_token}" unless session.access_token.nil?
+        request.headers["Content-Type"] = content_type
         request.params = params.to_h.camelize_keys
         request.body = file_binary
       end
@@ -51,5 +53,20 @@ module BeyondApi
 
       [response.body.blank? ? nil : JSON.parse(response.body), response.status]
     end
+
+    def self.upload_by_form(session, path, files, params)
+      response = BeyondApi::Connection.multipart.post do |request|
+        request.url(session.api_url + path)
+        request.headers["Authorization"] = "Bearer #{session.access_token}" unless session.access_token.nil?
+        request.options[:params_encoder] = Faraday::FlatParamsEncoder
+        request.params = params.to_h.camelize_keys
+        files = files.split unless files.is_a? Array
+        upload_files = files.map{ |file| Faraday::FilePart.new(File.open(file),
+                                                               BeyondApi::Utils.file_content_type(file)) }
+        request.body = { image: upload_files }
+      end
+
+      [response.body.blank? ? nil : JSON.parse(response.body), response.status]
+    end
   end
 end