safen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17a10cc0c9cfacaa50984aa85ca92507361975d1
+  data.tar.gz: faf894f100c853dbd9a72c32b7364fcbe7756f0b
+SHA512:
+  metadata.gz: 188d2c54068b41b1a0d120b78c24db0e697e161b2893c43462294ca16d441a0cdb4c31d7a93de8619adbd70ba41815be5f31f40d8ceebc78eb1851ffab45f5c9
+  data.tar.gz: aa9e2d62f739dcea36baee8114c34c041327ad7e19a9914430995e271af3275caa844688b842c8165150dea2864791b2d8f616d79d8001290ce330f75b4beeb7

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# IntelliJ
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in safen.gemspec
+gemspec

data/README.md

@@ -0,0 +1,109 @@
+# Safen
+
+SKT Safen 연동 API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safen
+
+## Usage
+
+### 매핑 요청
+
+```
+Safen.new('xxxx', ['xxx.xxx.xxx.xxx:xxxx']).create old_tel_num, group_code
+```
+
+**params**
+
+- `old_tel_num`: 실제 사용중인 착신번호
+- `group_code`: 그룹코드
+
+**ret**
+
+연동 성공시 연동된 0504 전화번호, 실패시 결과 코드표 참고
+
+### 수정 요청
+
+```
+Safen.new('xxxx', ['xxx.xxx.xxx.xxx:xxxx']).update old_tel_num, group_code, new_tel_num
+```
+
+**params**
+
+- `old_tel_num`: 실제 사용중인 착신번호
+- `group_code`: 그룹코드
+- `new_tel_num`: 맵핑할 번호
+
+**ret**
+
+연동 성공시 0000, 실패시 결과 코드표 참고
+
+### 취소 요청
+
+```
+Safen.new('xxxx', ['xxx.xxx.xxx.xxx:xxxx']).remove new_tel_num, group_code
+```
+
+**params**
+
+- `new_tel_num`: 0504 연동 번호
+- `group_code`: 그룹코드
+
+**ret**
+
+연동 성공시 0000, 실패시 결과 코드표 참고
+
+### 매핑 조회
+
+```
+Safen.new('xxxx', ['xxx.xxx.xxx.xxx:xxxx']).show new_tel_num, group_code
+```
+
+**params**
+
+- `corp_code`: 업체코드
+- `new_tel_num`: 0504 연동 번호
+
+**ret**
+
+연동 성공시 연동된 착신번호, 해지된 안심번호 조회 요청시 E401
+
+### 결과 코드표
+
+| 코드 | 확인 | 설명 | 
+|---|---|---|
+| 0000 | 성공 처리 | 인증서버에서 요청 처리가 성공. |
+| E101 | Network 장애 | 인증서버와 연결 실패. |
+| E102 | System 장애. | 인증서버의 일시적 장애. 재시도 요망. |
+| E201 | 제휴사 인증 실패. | 유효한 제휴사 코드가 아님. |
+| E202 | 유효 기간 만료. | 제휴사와의 계약기간 만료. |
+| E203 | 부가서비스 인증 실패 | 제휴사의 부가서비스 인증 실패. |
+| E301 | 안심 번호 소진. | 유효한 안심번호 자원이 없슴. |
+| E401 | Data Not Found | 요청한 Data와 일치하는 Data가 없슴. |
+| E402 | Data Overlap | 요청한 Data가 이미 존재함. |
+| E501 | 전문 오류 | 전문 공통부 혹은 본문의 Data가 비정상일 경우. |
+| E502 | 전화 번호 오류 | 요청한 착신번호가 맵핑불가 번호일 경우 |
+| E503 | 금칙어 오류 | 요청한 알림 내용이 금칙어를 포함한 경우 |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/subicura/safen.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "safen"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/safen.rb

@@ -0,0 +1,127 @@
+require 'socket'
+require 'safen/version'
+require 'safen/header'
+require 'safen/body'
+require 'safen/error'
+
+class Safen
+  attr_reader :api_server_entpoints, :corp_code
+
+  # 고객코드와 api server endpoint 리스트로 초기화
+  # @param corp_code [String] 고객코드
+  # @param api_server_entpoints list[String] endpoint ip:port
+  def initialize(corp_code, api_server_entpoints)
+    @corp_code = corp_code
+    @api_server_entpoints = api_server_entpoints
+  end
+
+  def call_api(header, body)
+    ret = {}
+
+    @api_server_entpoints.each_with_index do |endpoint, idx|
+      ip, port = endpoint.split(':')
+
+      begin
+        socket = TCPSocket.new(ip, port.to_i)
+        socket.puts("#{header}#{body}")
+
+        ret[:size] = socket.read(4).to_i
+        ret[:code] = socket.read(4)
+        ret[:corp_code] = socket.read(4)
+
+        ret[:data] = socket.read(ret[:size])
+
+        break # 성공시 탈출
+      rescue => e
+        if idx == @api_server_entpoints.size - 1 # last
+          raise e
+        else
+          next # 실패시 다음 엔드포인드 진행
+        end
+      ensure
+        socket.close if socket
+      end
+    end
+
+    if ret[:code] == '2001' # 매핑 응답
+      return ret[:data][20...24], ret[:data][0...20].strip
+    elsif ret[:code] == '2002' # 해제 응답
+      return ret[:data][0...4], nil
+    elsif ret[:code] == '2003' # 수정 응답
+      return ret[:data][0...4], nil
+    elsif ret[:code] == '2004' # 조회 응답
+      return ret[:data][0...4], ret[:data][4...24].strip
+    end
+
+    return nil, nil
+  end
+
+  # 매핑 요청
+  # @param old_tel_num [String] 실제 사용중인 착신번호
+  # @param group_code [String] 그룹코드
+  # @return [String] 매핑된 전화 번호
+  def create(old_tel_num, group_code)
+    header = Header.mapping_request(@corp_code)
+    body = Body.mapping_request(old_tel_num, group_code)
+
+    code, data = call_api(header, body)
+
+    if code != '0000'
+      raise SafenError.new(code), "Safen API call error #{code}"
+    end
+
+    data
+  end
+
+  # 수정 요청
+  # @param old_tel_num [String] 실제 사용중인 착신번호
+  # @param group_code [String] 그룹코드
+  # @param new_tel_num [String] 매핑할 번호
+  # @return [bool] 성공여부
+  def update(old_tel_num, group_code, new_tel_num)
+    header = Header.mapping_update_request(@corp_code)
+    body = Body.mapping_update_request(old_tel_num, new_tel_num, group_code)
+
+    code, data = call_api(header, body)
+
+    if code != '0000'
+      raise SafenError.new(code), "Safen API call error #{code}"
+    end
+
+    true
+  end
+
+  # 취소 요청
+  # @param new_tel_num [String] 매핑할 번호
+  # @param group_code [String] 그룹코드
+  # @return [bool] 성공여부
+  def remove(new_tel_num, group_code)
+    header = Header.mapping_cancel_request(@corp_code)
+    body = Body.mapping_cancel_request(new_tel_num, group_code)
+
+    code, data = call_api(header, body)
+
+    if code != '0000'
+      raise SafenError.new(code), "Safen API call error #{code}"
+    end
+
+    true
+  end
+
+  # 매핑 조회 요청
+  # @param new_tel_num [String] 매핑된 번호
+  # @param group_code [String] 그룹 코드
+  # @return [bool] 매핑된 전화 번호
+  def show(new_tel_num, group_code)
+    header = Header.mapping_show_request(@corp_code)
+    body = Body.mapping_show_request( new_tel_num, group_code)
+
+    code, data = call_api(header, body)
+
+    if code != '0000'
+      raise SafenError.new(code), "Safen API call error #{code}"
+    end
+
+    data
+  end
+end

data/lib/safen/body.rb

@@ -0,0 +1,53 @@
+class Safen
+  class Body
+    class << self
+      # 전화번호 매핑
+      #
+      # 설명 offset, length
+      # 착신번호1 0, 20 (연동할 전화번호)
+      # 착신번호2 20, 20 (현재는 착신번호1과 동일하게 사용)
+      # 그룹코드 40, 10 (수정할 그룹코드)
+      # Reserved1 50, 50 (예약필드)
+      # Reserved2 100, 10 (예약필드)
+      def mapping_request(old_tel_num, group_code)
+        tel_num = old_tel_num.gsub(/-/, '')
+        "#{tel_num.ljust(20, ' ')}#{tel_num.ljust(20, ' ')}#{group_code.ljust(10, ' ')}#{' ' * 50}#{' ' * 10}"
+      end
+
+      # 전화번호 매핑 수정
+      def mapping_update_request(old_tel_num, new_tel_num, group_code)
+        default_old_tel_num = '1234567890'
+        old_tel_num_nomalize = old_tel_num.gsub(/-/, '')
+        new_tel_num_nomalize = new_tel_num.gsub(/-/, '')
+
+        ret = ''
+        ret += "#{new_tel_num_nomalize.ljust(20, ' ')}"
+        ret += "#{default_old_tel_num.ljust(20, ' ')}#{old_tel_num_nomalize.ljust(20, ' ')}"
+        ret += "#{default_old_tel_num.ljust(20, ' ')}#{old_tel_num_nomalize.ljust(20, ' ')}"
+        ret += "#{group_code.ljust(10, ' ')}"
+        ret += "#{' ' * 50}#{' ' * 10}"
+
+        ret
+      end
+
+      # 전화번호 매핑 해제
+      #
+      # 설명 offset, length
+      # 0504 매핑번호 0, 20 (매핑된 전화번호)
+      # 그룹코드 20, 10 (수정할 그룹코드)
+      def mapping_cancel_request(new_tel_num, group_code)
+        tel_num = new_tel_num.gsub(/-/, '')
+        "#{tel_num.ljust(20, ' ')}#{group_code.ljust(10, ' ')}"
+      end
+
+      # 전화번호 매핑 조회
+      #
+      # 설명 offset, length
+      # 0504 매핑번호 0, 20 (매핑된 전화번호)
+      def mapping_show_request(new_tel_num, group_code)
+        tel_num = new_tel_num.gsub(/-/, '')
+        "#{tel_num.ljust(20, ' ')}"
+      end
+    end
+  end
+end

data/lib/safen/error.rb

@@ -0,0 +1,9 @@
+class Safen
+  class SafenError < StandardError
+    attr_reader :code
+
+    def initialize(code = nil)
+      @code = code
+    end
+  end
+end

data/lib/safen/header.rb

@@ -0,0 +1,32 @@
+class Safen
+  class Header
+    class << self
+      # 전화번호 매핑
+      def mapping_request(corp_code)
+        create_header 110, '1001', corp_code
+      end
+
+      # 전화번호 매핑 수정
+      def mapping_update_request(corp_code)
+        create_header 170, '1003', corp_code
+      end
+
+      # 전화번호 매핑 해제
+      def mapping_cancel_request(corp_code)
+        create_header 30, '1002', corp_code
+      end
+
+      # 전화번호 매핑 조회
+      def mapping_show_request(corp_code)
+        create_header 20, '1004', corp_code
+      end
+
+      # 전문길이 (4byte) Header를 제외한 Body data size
+      # 업무구분코드 (4byte)
+      # 업체코드 (4byte) Telink 에서 부여.
+      def create_header(len, code, corp_code)
+        "#{len.to_s.rjust(4, '0')}#{code}#{corp_code}"
+      end
+    end
+  end
+end

data/lib/safen/version.rb

@@ -0,0 +1,3 @@
+class Safen
+  VERSION = "0.1.0"
+end

data/safen.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'safen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'safen'
+  spec.version       = Safen::VERSION
+  spec.authors       = ['subicura']
+  spec.email         = ['subicura@subicura.com']
+
+  spec.summary       = %q{Ruby bindings for the SKT safen API}
+  spec.description   = %q{SKT safen is 0504 tel service.}
+  spec.homepage      = 'https://github.com/subicura/safen-ruby'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: safen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- subicura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: SKT safen is 0504 tel service.
+email:
+- subicura@subicura.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/safen.rb
+- lib/safen/body.rb
+- lib/safen/error.rb
+- lib/safen/header.rb
+- lib/safen/version.rb
+- safen.gemspec
+homepage: https://github.com/subicura/safen-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the SKT safen API
+test_files: []