기능: 외부채널 데이터에 대한 검색 조건 추가(created_at) 및 외부채널 cart_item에 unit_price 개념 도입 (#125)

* 핫픽스: 배송 관련 필드 타입 수정 (#49)

* shipping_addresses 테이블 문자셋을 utf8mb4 로 변경

* ship_info.user_memo 필드 타입을 Text 로 변경

* 핫픽스 : gomibranch 에 store module 명시

* 수정 : gomibranch payment manager 추가

* 수정: 마이그레이션으로 인한 annotate 작동

* 수정: 외부채널 컨트롤러가 매니저에게 전달하는 파라미터를 해시로 변경

* 수정: 베이스 어댑터의 parse_query_hash 메소드 수정

* 수정: 하라반, 티키 어댑터에 변경사항 적용

* 수정: 베이스 어댑터에 주석 추가

* 수정: 개발 환경에서 사용할 lazada app console 정보 업데이트

* 수정: 하라반 어댑터 오류 수정

* 수정: 라자다 어댑터에 parse_query_hash 메소드 업데이트 적용

* 수정: 파트너 센터 유저의 jwt 기한을 임시로 1년으로 수정

* 수정: cors에 스테이징 파트너센터 url을 추가

* 수정: 쇼피 어댑터 일부 수정, 승찬님께 전달

* 형식: uniprice 추가에 따른 주석 변경

* 리팩토링: 쇼피 어뎁터 parse query방식 수정

사용하기로 협의한대로 사용할 수 있도록 parse query 변경

* 기능: external_channel_cart_item에 unit price 컬럼 추가 (#124)

* 기능: 외부채널 cart item에 unit 가격 추가

외부채널 cart item에 값 보정을 위한 unit price 컬럼 추가 및 데이터 받아옴

* 형식: DB 변경에 따른 주석 변경

* 리팩토링: sendo 어뎁터 요청 방식 규정

sendo 어뎁터에서 새로 규정한 request 방식으로 요청을 보내고 받을 수 있도록 리팩토링

* 리팩토링: 쇼피 호출 로직 변경

기존에 2중 while문 사용하면서 읽기 어려워서 query생성하는 함수를 추가했다.

* 수정: 라자다 어댑터에서 데이터가 없을 경우 에러를 발생시키지 않도록 수정

* 수정: 용현님 코드리뷰 적용

* 수정: 외부채널 어댑터 query_hash 데이터 스타일 통일

* 버그: 쇼피 어뎁터 일자 안잘리는 문제

hash 포인터를 받아서 생기는 에러였다.

Co-authored-by: Yonghyun Kim (Freddy) <fred@gomicorp.com>
Co-authored-by: Lee seung chan <dltmdcks702@gmail.com>
Co-authored-by: Bran <40688044+june20516@users.noreply.github.com>

Author: 4 people

Gemfile

@@ -22,6 +22,7 @@ gem 'schema_to_scaffold'
 gem 'http_accept_language'
 gem 'locale_router', git: 'https://github.com/yhk1038/locale_router.git'
 gem 'omise'
+gem 'iamport'
 gem 'rack-cors'
 gem 'rails-file_storage', git: 'https://github.com/yhk1038/file_storage.git'
 

app/adapters/external_channel/adapter_factory.rb

@@ -1,18 +1,21 @@
 module ExternalChannel
   class AdapterFactory
-    def self.get_adapter(channel_name)
-      case channel_name.downcase
-      when 'haravan'
-        HaravanAdapter.new
-      when 'tiki'
-        TikiAdapter.new
-      when 'sendo'
-        SendoAdapter.new
-      when 'lazada'
-        LazadaAdapter.new
-      when 'shopee'
-        ShopeeAdapter.new
-      else
+    class << self
+      def known_adapter_map
+        {
+          haravan: HaravanAdapter,
+          tiki: TikiAdapter,
+          sendo: SendoAdapter,
+          lazada: LazadaAdapter,
+          shopee: ShopeeAdapter
+        }
+      end
+
+      def adapter(channel_name)
+        known_adapter_map[channel_name.to_s.downcase.to_sym].new || adapter_not_found!
+      end
+
+      def adapter_not_found!
         raise NotImplementedError, 'Requested Data Is Not Supported!'
       end
     end

app/adapters/external_channel/base_adapter.rb

@@ -1,6 +1,6 @@
 module ExternalChannel
   class BaseAdapter
-    DEAFULT_EXCEPTION = [
+    DEFAULT_EXCEPTION = [
       Errno::ETIMEDOUT, Timeout::Error,
       Faraday::TimeoutError, Faraday::RetriableResponse, Faraday::ConnectionFailed
     ].freeze
@@ -28,7 +28,7 @@ def check_token_validation; end
 
     # == 리퀘스트를 던지는 caller 메소드입니다.
     def request_get(endpoint, params, headers, retry_exceptions = nil)
-      retry_exceptions ||= DEAFULT_EXCEPTION
+      retry_exceptions ||= DEFAULT_EXCEPTION
       Faraday.new(endpoint, params: params, request: { open_timeout: 5, timeout: 5 }) do |conn|
         conn.response :logger, Rails.logger
         conn.request(:retry, max: 5, interval: 1, exceptions: retry_exceptions)
@@ -38,7 +38,7 @@ def request_get(endpoint, params, headers, retry_exceptions = nil)
     end
 
     def request_post(endpoint, body, headers, retry_exceptions = nil)
-      retry_exceptions ||= DEAFULT_EXCEPTION
+      retry_exceptions ||= DEFAULT_EXCEPTION
       Faraday.new(endpoint, request: { open_timeout: 5, timeout: 5 }) do |conn|
         conn.response :logger, Rails.logger
         conn.request(:retry, max: 5,
@@ -54,7 +54,20 @@ def request_post(endpoint, body, headers, retry_exceptions = nil)
     end
 
     # == 전달받은 쿼리 파라미터를 각 채널의 포맷에 맞게 변환합니다.
-    def parse_query_hash(query); end
+    # == query_mapper 와 date_formatter 가 반드시 필요합니다.
+    # == query_mapper 와 date_formatter 는 하위 클래스에서 세부 구현합니다.
+    def parse_query_hash(query_mapper, query_hash)
+      query_hash['from'] ||= date_formatter((DateTime.now - 1.days).beginning_of_day.utc)
+      query_hash['to'] ||= date_formatter((DateTime.now - 1.days).end_of_day.utc)
+      query_hash['key'] ||= 'updated'
+      
+      query_hash.replace({
+                           query_mapper[query_hash['key']][0]=> date_formatter(query_hash['from'].to_time),
+                           query_mapper[query_hash['key']][1]=> date_formatter(query_hash['to'].to_time)
+                         })
+    end
+
+    def date_formatter(utc_time); end
 
     # == 적절하게 정제된 데이터를 리턴합니다.
     def products(query = {}); end

app/adapters/external_channel/haravan_adapter.rb

@@ -40,6 +40,11 @@ class HaravanAdapter < BaseAdapter
       # = fields : response 데이터 중 특정 스키마만 골라서 볼 수 있습니다
     }
 
+    QUERY_MAPPER = {
+      'created'=> %w[created_at_min created_at_max],
+      'updated'=> %w[updated_at_min updated_at_max],
+    }
+
     def initialize
       super
       api_key = Rails.application.credentials.dig(:haravan, :api, :key)
@@ -52,26 +57,17 @@ def initialize
 
     # == 적절하게 정제된 데이터를 리턴합니다.
     def products(query_hash = {})
-      parse_query_hash(query_hash)
-
-      refine_products(call_products(query_hash))
+      refine_products(call_products(parse_query_hash(QUERY_MAPPER, query_hash)))
     end
 
     def orders(query_hash = {})
-      parse_query_hash(query_hash)
-
-      refine_orders(call_orders(query_hash))
+    refine_orders(call_orders(parse_query_hash(QUERY_MAPPER, query_hash)))
     end
 
     def login; end
 
-    def parse_query_hash(query_hash)
-      query_hash['updated_from'] ||= DateTime.now - 1.days
-      query_hash['updated_to'] ||= DateTime.now
-      query_hash['updated_at_min'] = query_hash['updated_from'].to_s
-      query_hash['updated_at_max'] = query_hash['updated_to'].to_s
-      query_hash.delete('updated_from')
-      query_hash.delete('updated_to')
+    def date_formatter(utc_time)
+      utc_time.strftime('%Y-%m-%d %H:%M')
     end
 
     # == 외부 채널의 API 를 사용하여 각 레코드를 가져옵니다.
@@ -151,7 +147,7 @@ def refine_orders(records)
           paid_at: paid_at,
           billing_amount: record['total_price'],
           ship_fee: record['shipping_lines'].inject(0) { |sum, line| sum + (line['price']) },
-          variant_ids: record['line_items'].map { |variant| [variant['variant_id'], variant['quantity'].to_i] },
+          variant_ids: record['line_items'].map { |variant| [variant['variant_id'], variant['quantity'].to_i, variant['price'].to_i ] },
           cancelled_status: record['cancelled_status'],
           shipping_status: record['fulfillments_status']
         }

app/adapters/external_channel/lazada_adapter.rb

@@ -29,12 +29,23 @@ class LazadaAdapter < BaseAdapter
         # = sort_direction : 오름차순과 내림차순을 결정
         # = offset : 지정한 갯수의 데이터를 skip
         # = limit : 응답 받을 데이터의 갯수
-        # = create_before : 주문 생성 시간 <= date (ISO 8601)
-        # = create_after : 주문 생성 시간 >= date (ISO 8601)
+        # = created_before : 주문 생성 시간 <= date (ISO 8601)
+        # = created_after : 주문 생성 시간 >= date (ISO 8601)
         # = update_before : 주문 업데이트 시간 <= date (ISO 8601)
         # = update_after : 주문 업데이트 시간 >= date (ISO 8601)
     }
 
+    QUERY_MAPPER = {
+      'products'=> {
+        'created'=> %w[create_after create_before],
+        'updated'=> %w[update_after update_before],
+      },
+      'orders'=> {
+        'created'=> %w[created_after created_before],
+        'updated'=> %w[update_after update_before],
+      }
+    }
+
     def initialize
       super
       @token = ExternalChannel::Token.find_or_create_by(country: Country.send(ApplicationRecord.country_code),
@@ -62,7 +73,7 @@ def get_code
       options.add_argument('--no-sandbox')
 
       browser = Selenium::WebDriver.for :chrome, options: options
-      browser.navigate.to "https://auth.lazada.com/oauth/authorize?response_type=code&force_auth=true&redirect_uri=https://api.gomistore.com/external_channels/code&client_id=#{app_key}"
+      browser.navigate.to "https://auth.lazada.com/oauth/authorize?response_type=code&force_auth=true&redirect_uri=https://408d19fef5ad.ngrok.io/external_channels/code&client_id=#{app_key}"
 
       # = 로그인이 안 되어있는 경우 : form.empty? => true
       form = browser.find_elements(css: 'form[name=form1]')
@@ -131,29 +142,20 @@ def check_token_validation
     def products(query_hash = {})
       check_token_validation
 
-      parse_query_hash(query_hash)
-
-      refine_products(call_products(query_hash))
+      refine_products(call_products(parse_query_hash(QUERY_MAPPER['products'], query_hash)))
     end
 
     def orders(query_hash = {})
       check_token_validation
 
-      parse_query_hash(query_hash)
-
-      refine_orders(call_orders(query_hash))
+      refine_orders(call_orders(parse_query_hash(QUERY_MAPPER['orders'], query_hash)))
     end
 
     protected
     def login; end
 
-    def parse_query_hash(query_hash)
-      query_hash['updated_from'] ||= DateTime.now - 1.days
-      query_hash['updated_to'] ||= DateTime.now
-      query_hash['update_after'] = query_hash['updated_from'].to_time.iso8601.to_s
-      query_hash['update_before'] = query_hash['updated_to'].to_time.iso8601.to_s
-      query_hash.delete('updated_from')
-      query_hash.delete('updated_to')
+    def date_formatter(utc_time)
+      utc_time.to_datetime.iso8601
     end
 
     def call_products(query_hash)
@@ -162,8 +164,6 @@ def call_products(query_hash)
     end
 
     def call_orders(query_hash)
-      query_hash.merge!({ created_after: '2018-02-10T16:00:00+08:00' }) if query_hash.empty?
-
       response = request_get('/orders/get', query_hash)
       response.body['data']['orders']
     end
@@ -193,7 +193,7 @@ def refine_products(records)
             brand_name: record['attributes']['brand'],
             variants: refine_product_options(record['skus'])
         }
-      end
+      end if records.present?
 
       product_property
     end
@@ -223,7 +223,6 @@ def refine_orders(records)
 
       records.each do |record|
         call_order_items(record['order_id']).each_with_index do |order_item, index|
-          #Rails.logger.info order_item['sku']
           order_property << {
             id: "#{record['order_id']}-#{index}",
             order_number: record['order_number'],
@@ -235,13 +234,12 @@ def refine_orders(records)
             billing_amount: record['price'].to_i + record['shipping_fee'],
             ship_fee: record['shipping_fee'],
             cancelled_status: ['cancelled'].include?(order_item['status']) ? order_item['status'] : nil,
-            variant_ids: [[order_item['sku'].to_s, 1]],
+            variant_ids: [[order_item['sku'].to_s, 1, order_item['item_price'].to_i]],
             shipping_status: %w[ready_to_ship, delivered, shipped returned].include?(record['statuses']) ? order_item['status'] : nil
           }
         end
-      end
+      end if records.present?
 
-      #Rails.logger.info order_property
       order_property
     end
   end

app/adapters/external_channel/sendo_adapter.rb

@@ -16,7 +16,17 @@ class SendoAdapter < BaseAdapter
     #   order_status: 주문 상태
     # }
 
-    attr_reader :base_url, :default_headers, :token
+    attr_reader :base_url, :default_headers, :token, :request_type
+
+    QUERY_MAPPER = {
+      'products'=> {
+        'updated'=> %w[date_from date_to]
+      },
+      'orders'=> {
+        'created'=> %w[order_date_from order_date_to],
+        'updated'=> %w[order_status_date_from order_status_date_to]
+      }
+    }
 
     def initialize
       super
@@ -35,30 +45,26 @@ def check_token_validation
       login if !token.auth_token || @token.auth_token_expired?
     end
 
-    # query로 들어오는 값을 지원하는 방식에 맞게 수정합니다.
-
-    # === sendo는 데이터 형식에 따라 query를 리턴하는 방식이 다릅니다.
-    # === 따라서 curring하는 형식으로 처리했습니다.
-    def parse_query_hash(data_type)
-      case data_type
-      when 'product'
-        ->(query) { parse_query_on_product(default_query(query)) }
-      when 'order'
-        ->(query) { parse_query_on_order(default_query(query)) }
-      end
-    end
-
     # == 적절하게 정제된 데이터를 리턴합니다.
     def products(query_hash = {})
       check_token_validation
 
-      refine_products(call_products(parse_query_hash('product').call(query_hash)))
+      refine_products(call_products(parse_query_hash(QUERY_MAPPER['products'], query_hash)))
     end
 
     def orders(query_hash = {})
       check_token_validation
 
-      refine_orders(call_orders(parse_query_hash('order').call(query_hash)))
+      refine_orders(call_orders(parse_query_hash(QUERY_MAPPER['orders'], query_hash)))
+    end
+    
+    def parse_query_hash(query_mapper, query_hash)
+      @request_type = query_hash['key'] || 'updated'
+      super
+    end
+
+    def date_formatter(utc_time) 
+      utc_time.to_datetime.new_offset(0)
     end
 
     def login
@@ -101,8 +107,14 @@ def call_orders(query_hash = {})
         'Content-Type': 'application/json',
         'cache-control': 'no-cache'
       }
-      request_lists(orders_url, orders_body, orders_header) do |orders|
-        orders['result']['data']
+      from, to = QUERY_MAPPER['orders'][request_type]
+      interval = 2.days
+      request_interval(orders_body[from], orders_body[to], interval) do |requestFrom, requestTo|
+        orders_body[from] = date_time_format(requestFrom)
+        orders_body[to] = date_time_format(requestTo)
+        request_lists(orders_url, orders_body, orders_header) do |orders|
+          orders['result']['data']
+        end
       end
     end
 
@@ -127,7 +139,7 @@ def refine_orders(orders)
           id: sales_data['order_number'].to_s,
           order_number: sales_data['order_number'],
           billing_amount: sales_data['total_amount_buyer'],
-          variant_ids: sales_details.map { |option| [option['sku'], option['quantity']] },
+          variant_ids: sales_details.map { |option| [ option['sku'], option['quantity'].to_i, option['price'].to_i ] },
           order_status: map_order_status(sales_data['order_status']),
           cancelled_status: cancelled_status(sales_data['order_status']),
           shipping_status: shipping_status(sales_data['order_status']),
@@ -142,30 +154,8 @@ def refine_orders(orders)
 
     private
 
-    ### === 요청 query데이터를 parsing하는 로직입니다.
-
-    def parse_query_on_product(query_hash)
-      update_from = query_hash[:updated_from].to_datetime
-      update_to = query_hash[:updated_to].to_datetime
-      {
-        date_from: "#{update_from.year}/#{update_from.month}/#{update_from.day}",
-        date_to: "#{update_to.year}/#{update_to.month}/#{update_to.day}"
-      }
-    end
-
-    def parse_query_on_order(query_hash)
-      update_from = query_hash[:updated_from].to_datetime
-      update_to = query_hash[:updated_to].to_datetime
-      {
-        order_date_from: "#{update_from.year}/#{update_from.month}/#{update_from.day}",
-        order_date_to: "#{update_to.year}/#{update_to.month}/#{update_to.day}"
-      }
-    end
-    
-    def default_query(query_hash)
-      query_hash[:updated_from] ||= Time.now - 1.days
-      query_hash[:updated_to] ||= Time.now
-      query_hash
+    def date_time_format(utc_time)
+      "#{utc_time.year}/#{utc_time.month}/#{utc_time.day}"
     end
 
     ### === 데이터를 불러오는 로직입니다.
@@ -190,6 +180,19 @@ def get_all_by_ids(ids, url, query_hash = {})
       end
     end
 
+    def request_interval(from, to, interval)
+      return unless block_given?
+
+      data = []
+      while from < to
+        tempFrom = to - interval
+        request_from = tempFrom < from ? from : tempFrom
+        data << yield(request_from, to)
+        to = request_from
+      end
+      data.flatten
+    end
+
     # == list 에서 모든 데이터를 요청합니다.
     def request_lists(url, body, header)
       body[:token] = ''