easycodefrb 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b266bb709932b66307dcd683b3054d72dbc28e7508cc17b6a04d5dc6a20a7477
+  data.tar.gz: a2d79e5e4d8312bdaa46daf1c64454deca5356cbfe15c361a97c7056c769f06e
+SHA512:
+  metadata.gz: 4f2493773bc3348682f7432c6424d8a654319960681eec78bda5fb129827540963710c6d4fe00c0d8940abfafb904aedb19d9b9b3494c4f6f8a8bd254f1b71be
+  data.tar.gz: e4eddeb0dcae91b6ff8e30a09f7fd0463c23531b5325650f66953f13a64455e0c9cd08f9f36a3adce3703febf808ee38c5a307dc5001b1679e9238ea520f0d98

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 CODEF Inc.
+
+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/lib/easycodefrb.rb

@@ -0,0 +1,10 @@
+require_relative './easycodefrb/connector'
+require_relative './easycodefrb/easycodef'
+require_relative './easycodefrb/properties'
+require_relative './easycodefrb/response'
+require_relative './easycodefrb/message'
+require_relative './easycodefrb/util'
+
+module EasyCodef
+  VERSION = '1.0.2'
+end

data/lib/easycodefrb/connector.rb

@@ -0,0 +1,113 @@
+require 'net/http'
+require 'uri'
+require 'cgi'
+require 'json'
+require 'base64'
+
+require_relative './response'
+require_relative './message'
+
+# 상품 요청
+module Connector
+  module_function()
+
+  def request_product(req_url, token, body_str)
+    uri = URI.parse(req_url)
+    header = {
+      'Content-Type': 'application/x-www-form-urlencoded',
+      'Accept': 'application/json'
+    }
+
+    if token != '' && token != nil
+      header['Authorization'] = 'Bearer ' + token
+    end
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    req = Net::HTTP::Post.new(uri.request_uri, header)
+    req.body = body_str
+
+    res = http.request(req)
+
+    return case res
+    when Net::HTTPOK
+      data = CGI::unescape(res.body)
+      return JSON.parse(data)
+    when Net::HTTPBadRequest
+      new_response_message(Message::BAD_REQUEST)
+    when Net::HTTPUnauthorized
+      new_response_message(Message::UNAUTHORIZED)
+    when Net::HTTPForbidden
+      new_response_message(Message::FORBIDDEN)
+    when Net::HTTPNotFound
+      new_response_message(Message::NOT_FOUND)
+    else
+      new_response_message(Message::SERVER_ERROR)
+    end
+  end
+
+  # 엑세스 토큰 요청
+  def request_token(client_id, client_secret)
+    uri = URI.parse(EasyCodef::OAUTH_DOMAIN + EasyCodef::PATH_GET_TOKEN)
+
+    auth = client_id + ':' + client_secret
+    enc_auth = Base64.encode64(auth).gsub(/\n/, '')
+
+    header = {
+      'Content-Type': 'application/x-www-form-urlencoded',
+      'Authorization': 'Basic ' + enc_auth
+    } 
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    req = Net::HTTP::Post.new(uri.request_uri, header)
+    req.body = 'grant_type=client_credentials&scope=read'
+    
+    res = http.request(req)
+
+    return case res
+    when Net::HTTPOK
+      JSON.parse(res.body)
+    else
+      return nil
+    end
+  end
+
+  # 토큰 셋팅
+  # Codef 인스턴스 변수에 조회된 access_token을 셋팅한다
+  def set_token(client_id, client_secret, access_token_cls, service_type)
+    repeat_cnt = 3
+    i = 0
+    if access_token_cls.get_token(service_type) == ''
+      while i < repeat_cnt
+        token_map = request_token(client_id, client_secret)
+        if token_map != nil
+          access_token = token_map[EasyCodef::KEY_ACCESS_TOKEN]
+          access_token_cls.set_token(access_token, service_type)
+          if access_token != nil && access_token != ''
+            break
+          end
+        end
+
+        sleep(0.020)
+        i += 1
+      end
+    end
+  end
+
+  # API 요청 실행
+  def execute(url_path, body, access_token_cls, req_info, service_type)
+    set_token(
+      req_info.client_id,
+      req_info.client_secret,
+      access_token_cls,
+      service_type
+    )
+    enc_body = CGI::escape(body.to_json())
+    return request_product(
+      req_info.domain + url_path,
+      access_token_cls.get_token(service_type),
+      enc_body
+    )
+  end
+end

data/lib/easycodefrb/easycodef.rb

@@ -0,0 +1,297 @@
+require_relative './message'
+require_relative './connector'
+
+module EasyCodef
+  # AccessToken 정보
+  class AccessToken
+    def initialize()
+      @product = ''
+      @demo = ''
+      @sandbox = ''
+    end
+
+    def set_token(token, service_type)
+      case service_type
+      when TYPE_PRODUCT
+        @product = token
+      when TYPE_DEMO
+        @demo = token
+      else
+        @sandbox = token
+      end
+    end
+
+    def get_token(service_type)
+      return case service_type
+      when TYPE_PRODUCT
+        @product
+      when TYPE_DEMO
+        @demo
+      else
+        @sandbox
+      end
+    end
+  end
+
+  # API 요청에 필요한 정보 클래스
+  # Codef 인스턴스에서 API 요청을 보낼때 서비스 타입별 필요한 정보를 가져와서 사용한다
+  # 이때 정보를 저장하는 역할을 한다
+  class RequestInfo
+    def initialize(domain, client_id, client_secret)
+      @domain = domain
+      @client_id = client_id
+      @client_secret = client_secret
+    end
+
+    def domain()
+      return @domain
+    end
+
+    def client_id()
+      return @client_id
+    end
+
+    def client_secret()
+      return @client_secret
+    end
+  end
+
+  # Codef 클래스
+  # 요청에 필요한 설정 값들을 가지고 있으며
+  # 유저의 요청 파라미터에 따라 실제 API를 요청하는 역할을 한다
+  class Codef
+    def initialize(public_key='')
+      @access_token = AccessToken.new()
+      @demo_client_id = ''
+      @demo_client_secret = ''
+      @client_id = ''
+      @client_secret = ''
+      @public_key = public_key
+    end
+    
+    # 정식버전 클라이언트 정보 셋팅
+    def set_client_info(id, secret)
+      @client_id = id
+      @client_secret = secret
+    end
+
+    # 데모버전 클라이언트 정보 셋팅
+    def set_client_info_for_demo(id, secret)
+      @demo_client_id = id
+      @demo_client_secret = secret
+    end
+
+    def demo_client_id
+      return @demo_client_id
+    end
+
+    def demo_client_secret
+      return @demo_client_secret
+    end
+
+    def client_id
+      return @client_id
+    end
+
+    def client_secret
+      return @client_secret
+    end
+
+    def access_token
+      return @access_token
+    end
+
+    def public_key (public_key=nil)
+      @public_key = public_key if public_key
+      return @public_key
+    end
+
+
+    # 서비스 타입에 해당하는 요청 정보 객체 가져오기
+    def get_req_info_by_service_type(service_type)
+      return case service_type
+      when TYPE_PRODUCT
+        RequestInfo.new(
+          API_DOMAIN,
+          @client_id,
+          @client_secret
+        )
+      when TYPE_DEMO
+        RequestInfo.new(
+          DEMO_DOMAIN,
+          @demo_client_id,
+          @demo_client_secret
+        )
+      else
+        RequestInfo.new(
+          SANDBOX_DOMAIN,
+          SANDBOX_CLIENT_ID,
+          SANDBOX_CLIENT_SECRET
+        )
+      end
+    end
+
+    # API 요청
+    def request_product(product_path, service_type, param)
+
+      # 클라이언트 정보 검사
+      if !has_client_info(service_type)
+        res = new_response_message(Message::EMPTY_CLIENT_INFO)
+        return res.to_json()
+      end
+
+      # 퍼블릭키 검사
+      if @public_key == ''
+        res = new_response_message(Message::EMPTY_PUBLIC_KEY)
+        return res.to_json()
+      end
+
+      # 추가인증 키워드 비어있는지 체크
+      if !is_empty_two_way_keyword(param)
+        res = new_response_message(Message::INVALID_2WAY_KEYWORD)
+        return res.to_json()
+      end
+
+      # 리퀘스트 정보 조회
+      req_info = get_req_info_by_service_type(service_type)
+
+      # 요청
+      res = Connector.execute(
+        product_path,
+        param,
+        @access_token,
+        req_info,
+        service_type
+      )
+      return res.to_json()
+    end
+
+    # 상품 추가인증 요청
+    def request_certification(product_path, service_type, param)
+      # 클라이언트 정보 검사
+      if !has_client_info(service_type)
+        res = new_response_message(Message::EMPTY_CLIENT_INFO)
+        return res.to_json()
+      end
+
+      # 퍼블릭키 검사
+      if @public_key == ''
+        res = new_response_message(Message::EMPTY_PUBLIC_KEY)
+        return res.to_json()
+      end
+
+      # 추가인증 파라미터 필수 입력 체크
+      if !has_require_two_way_info(param)
+        res = new_response_message(Message::INVALID_2WAY_INFO)
+        return res.to_json()
+      end
+      
+      # 리퀘스트 정보 조회
+      req_info = get_req_info_by_service_type(service_type)
+
+      # 요청
+      res = Connector.execute(
+        product_path,
+        param,
+        @access_token,
+        req_info,
+        service_type
+      )
+      return res.to_json()
+    end
+
+    # 토큰 요청
+    def request_token(service_type)
+      if !has_client_info(service_type)
+        return nil
+      end
+
+      return case service_type
+      when TYPE_PRODUCT
+        Connector.request_token(@client_id, @client_secret)
+      when TYPE_DEMO
+        Connector.request_token(@demo_client_id, @demo_client_secret)
+      else 
+        Connector.request_token(SANDBOX_CLIENT_ID, SANDBOX_CLIENT_SECRET)
+      end
+    end
+
+    # connectedID 발급을 위한 계정 등록
+    def create_account(service_type, param)
+      return request_product(PATH_CREATE_ACCOUNT, service_type, param)
+    end
+
+    # 계정 정보 추가
+    def add_account(service_type, param)
+      return request_product(PATH_ADD_ACCOUNT, service_type, param)
+    end
+
+    # 계정 정보 수정
+    def update_account(service_type, param)
+      return request_product(PATH_UPDATE_ACCOUNT, service_type, param)
+    end
+
+    # 계정 정보 삭제
+    def delete_account(service_type, param)
+      return request_product(PATH_DELETE_ACCOUNT, service_type, param)
+    end
+
+    # connectedID로 등록된 계정 목록 조회
+    def get_account_list(service_type, param)
+      return request_product(PATH_GET_ACCOUNT_LIST, service_type, param)
+    end
+
+    # 클라이언트 정보로 등록된 모든 connectedID 목록 조회
+    def get_connected_id_list(service_type, param)
+      return request_product(PATH_GET_CID_LIST, service_type, param)
+    end
+
+    private
+
+    # 클라이언트 정보 검사
+    def has_client_info(service_type)
+      return case service_type
+      when TYPE_PRODUCT
+        @client_id.strip != '' && client_secret.strip != ''
+      when TYPE_DEMO
+        @demo_client_id.strip != '' && @demo_client_secret.strip != ''
+      else
+        SANDBOX_CLIENT_ID.strip != '' && SANDBOX_CLIENT_SECRET.strip != ''
+      end
+    end
+  end
+end
+
+# 2Way 키워드 존재 여부 검사
+def is_empty_two_way_keyword(param)
+  if param == nil
+    return true
+  end
+  return param['is2Way'] == nil && param['twoWayInfo'] == nil
+end
+
+# 2Way 필수 데이터 검사
+def has_require_two_way_info(param)
+  if param == nil
+    return false
+  end
+  is2_way = param['is2Way']
+  if !!is2_way != is2_way || !is2_way
+    return false
+  end
+
+  two_way_info = param['twoWayInfo']
+  if two_way_info == nil
+    return false
+  end
+
+  return check_need_value_in_two_way_info(two_way_info)
+end
+
+# twoWayInfo 내부에 필요한 데이터가 존재하는지 검사
+def check_need_value_in_two_way_info(two_way_info)
+  return two_way_info['jobIndex'] != nil &&
+    two_way_info['threadIndex'] != nil &&
+    two_way_info['jti'] != nil &&
+    two_way_info['twoWayTimestamp'] != nil
+end

data/lib/easycodefrb/message.rb

@@ -0,0 +1,39 @@
+# 메시지 정보 클래스
+class MessageInfo
+  def initialize(code, message, extra_message='')
+    @code = code
+    @message = message
+    @extra_message = extra_message
+  end
+
+  def code()
+    return @code
+  end
+  
+  def message()
+    return @message
+  end
+
+  def extra_message()
+    return @extra_message
+  end
+end
+
+# 결과 메시지
+module Message
+  OK = MessageInfo.new("CF-00000", "성공")
+  INVALID_JSON = MessageInfo.new("CF-00002", "json형식이 올바르지 않습니다.")
+	INVALID_PARAMETER= MessageInfo.new("CF-00007", "요청 파라미터가 올바르지 않습니다.")
+	UNSUPPORTED_ENCODING = MessageInfo.new("CF-00009", "지원하지 않는 형식으로 인코딩된 문자열입니다.")
+	EMPTY_CLIENT_INFO = MessageInfo.new("CF-00014", "상품 요청을 위해서는 클라이언트 정보가 필요합니다. 클라이언트 아이디와 시크릿 정보를 설정하세요.")
+	EMPTY_PUBLIC_KEY = MessageInfo.new("CF-00015", "상품 요청을 위해서는 퍼블릭키가 필요합니다. 퍼블릭키 정보를 설정하세요.")
+	INVALID_2WAY_INFO = MessageInfo.new("CF-03003", "2WAY 요청 처리를 위한 정보가 올바르지 않습니다. 응답으로 받은 항목을 그대로 2way요청 항목에 포함해야 합니다.")
+	INVALID_2WAY_KEYWORD = MessageInfo.new("CF-03004", "추가 인증(2Way)을 위한 요청은 requestCertification메서드를 사용해야 합니다.")
+	BAD_REQUEST = MessageInfo.new("CF-00400", "클라이언트 요청 오류로 인해 요청을 처리 할 수 ​​없습니다.")
+	UNAUTHORIZED = MessageInfo.new("CF-00401", "요청 권한이 없습니다.")
+	FORBIDDEN = MessageInfo.new("CF-00403", "잘못된 요청입니다.")
+	NOT_FOUND = MessageInfo.new("CF-00404", "요청하신 페이지(Resource)를 찾을 수 없습니다.")
+	METHOD_NOT_ALLOWED = MessageInfo.new("CF-00405", "요청하신 방법(Method)이 잘못되었습니다.")
+	LIBRARY_SERNDER_ERROR = MessageInfo.new("CF-09980", "통신 요청에 실패했습니다. 응답정보를 확인하시고 올바른 요청을 시도하세요.")
+	SERVER_ERROR = MessageInfo.new("CF-09999", "서버 처리중 에러가 발생 했습니다. 관리자에게 문의하세요.")
+end

data/lib/easycodefrb/properties.rb

@@ -0,0 +1,45 @@
+module EasyCodef
+  OAUTH_DOMAIN = "https://oauth.codef.io" # OAUTH 서버 도메인
+  PATH_GET_TOKEN = "/oauth/token" # OAUTH 엑세스 토큰 발급 URL PATH
+  SANDBOX_DOMAIN = "https://sandbox.codef.io" # 샌드박스 서버 도메인
+  SANDBOX_CLIENT_ID = "ef27cfaa-10c1-4470-adac-60ba476273f9" # 샌드박스 엑세스 토큰 발급을 위한 클라이언트 아이디
+  SANDBOX_CLIENT_SECRET = "83160c33-9045-4915-86d8-809473cdf5c3" # 샌드박스 액세스 토큰 발급을 위한 클라이언트 시크릿
+  DEMO_DOMAIN = "https://development.codef.io" # 데모 서버 도메인
+  API_DOMAIN = "https://api.codef.io" # 정식 서버 도메인
+
+  PATH_CREATE_ACCOUNT = "/v1/account/create" # 계정 등록 URL
+  PATH_ADD_ACCOUNT = "/v1/account/add" # 계정 추가 URL
+  PATH_UPDATE_ACCOUNT = "/v1/account/update" # 계정 수정 URL
+  PATH_DELETE_ACCOUNT = "/v1/account/delete" # 계정 삭제 URL
+  PATH_GET_ACCOUNT_LIST = "/v1/account/list" # 계정 목록 조회 URL
+  PATH_GET_CID_LIST = "/v1/account/connectedId-list" # 커넥티드 아이디 목록 조회 URL
+
+  KEY_RESULT = "result" # 응답부 수행 결과 키워드
+  KEY_CODE = "code" # 응답부 수행 결과 메시지 코드 키워드
+  KEY_MESSAGE = "message" # 응답부 수행 결과 메시지 키워드
+  KEY_EXTRA_MESSAGE = "extraMessage" # 응답부 수행 결과 추가 메시지 키워드
+  KEY_DATA = "data"
+  KEY_ACCOUNT_LIST = "accountList" # 계정 목록 키워드
+  KEY_CONNECTED_ID = "connectedId"
+  KEY_ACCESS_TOKEN = 'access_token'
+
+  KEY_INVALID_TOKEN = "invalidToken" # 엑세스 토큰 거절 사유1
+  KEY_ACCESS_DENIEND = "accessDenied" # 엑세스 토큰 거절 사유2
+
+  TYPE_PRODUCT = 0
+  TYPE_DEMO = 1
+  TYPE_SANDBOX = 2
+end
+
+
+# 서비스 타입에 해당하는 코드에프 도메인 반환
+def get_codef_domain(service_type)
+  return case service_type
+  when EasyCodef::TYPE_PRODUCT
+    EasyCodef::API_DOMAIN
+  when EasyCodef::TYPE_DEMO
+    EasyCodef::DEMO_DOMAIN
+  else
+    EasyCodef::SANDBOX_DOMAIN
+  end
+end

data/lib/easycodefrb/response.rb

@@ -0,0 +1,12 @@
+# 메시지 정보로 결과 생성
+# MessageInfo 인스턴스를 받아서 메시지 정보로 해시를 만든다
+def new_response_message(message_info)
+  return {
+    'result'=>{
+      'code'=>message_info.code,
+      'message'=>message_info.message,
+      'extra_message'=>message_info.extra_message,
+    },
+    'data'=>{}
+  }
+end

data/lib/easycodefrb/util.rb

@@ -0,0 +1,24 @@
+require 'base64'
+require 'openssl'
+
+module EasyCodef
+  module_function()
+
+  # 파일을 base64 인코딩한다
+  # 파일 경로를 인자로 받는다
+  def encode_to_file_str(file_path)
+    file = File.open(file_path)
+    base_64 = Base64.encode64(file.read)
+    file.close()
+    return base_64.encode('UTF-8').gsub(/\n/, '')
+  end
+
+  # RSA 암호화한다
+  # 암호화할 정보와 퍼블릭키를 인자로 받는다
+  def encrypt_RSA(text, public_key)
+    pub = Base64.decode64(public_key)
+    key = OpenSSL::PKey::RSA.new(pub)
+    enc_str = key.public_encrypt(text)
+    return Base64.encode64(enc_str).gsub(/\n/, '')
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: easycodefrb
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- CODEF
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-09 00:00:00.000000000 Z
+dependencies: []
+description: This library for using CODEF API
+email:
+- codef.io.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/easycodefrb.rb
+- lib/easycodefrb/connector.rb
+- lib/easycodefrb/easycodef.rb
+- lib/easycodefrb/message.rb
+- lib/easycodefrb/properties.rb
+- lib/easycodefrb/response.rb
+- lib/easycodefrb/util.rb
+homepage: https://github.com/codef-io/easycodefrb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: COODEF Library
+test_files: []