einvoice-qr-encryptor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80fe255b1eff2143eafd740a98fe9b8609edf80e
+  data.tar.gz: f5812674d2cc380208ddcad647709851388975eb
+SHA512:
+  metadata.gz: ed9db4e706f23108c22c7f522e869de0215d9c67d1fe5f28afd6e63664ac452ac32216584ad34fbe033bd661bd85100a8dc9c39d2036a718e7bef8b06aa638a3
+  data.tar.gz: 47a1f41d462b43be2b8e332308732043b4331837e379cb7a995bd7d9f442777b08291f5c2fa45342b05e03ab62d0c261790e2e22cd6984f785fce8e26dcb9215

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 2.1
+  Exclude:
+    - tmp/*.rb
+Metrics:
+  Enabled: false
+Lint/UnusedMethodArgument:
+  Description: 'Checks for unused method arguments.'
+  Enabled: false
+Style/AsciiComments:
+  Description: 'Use only ascii symbols in comments.'
+  Enabled: false
+Style/FileName:
+  Description: 'Use snake_case for source file names.'
+  Enabled: false

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_group 'lib', 'lib'
+end

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.0
+  - 2.2.0
+  - 2.1.5
+before_install:
+  - gem update --system
+  - gem update bundler

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Calvert
+
+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,83 @@
+[![Gem Version](https://badge.fury.io/rb/einvoice-qr-encryptor.svg)](http://badge.fury.io/rb/einvoice-qr-encryptor)
+[![Build Status](https://travis-ci.org/CalvertYang/EInvoice-QR-Encryptor.svg?branch=master)](https://travis-ci.org/CalvertYang/EInvoice-QR-Encryptor)
+![Analytics](https://ga-beacon.appspot.com/UA-44933497-3/CalvertYang/EInvoice-QR-Encryptor?pixel)
+# EInvoice-QR-Encryptor
+
+Encrypt, decrypt and generate QR code information for einvoice(Taiwan)
+
+_Compatible with 2D barcode specification version 1.6_
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'einvoice-qr-encryptor'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install einvoice-qr-encryptor
+```
+
+## Usage
+
+```ruby
+cipher = EInvoiceQREncryptor::Cipher.new('FE0F50D87215F625D1248F5FDAEBA37F')
+```
+
+#### Encrypt plain text
+
+```ruby
+cipher.encrypt('AA123456781234')
+#=> '73UqXrAk5DsVNv2VEvIFkQ=='
+```
+
+#### Decrypt cipher text
+
+```ruby
+cipher.decrypt('73UqXrAk5DsVNv2VEvIFkQ==')
+#=> 'AA123456781234'
+```
+
+#### Generate QR Code information for invoice
+
+```ruby
+cipher.gen_qrcode_information(
+  invoice_number: 'AA12345678',
+  invoice_date: '1040511',
+  invoice_time: '090000',
+  random_number: '1234',
+  sales_amount: 100,
+  tax_amount: 0,
+  total_amount: 100,
+  buyer_identifier: '00000000',
+  represent_identifier: '00000000',
+  seller_identifier: '00000000',
+  business_identifier: '00000000',
+  product_array: []
+)
+#=> 'AA12345678104051112340000006400000064000000000000000073UqXrAk5DsVNv2VEvIFkQ=='
+```
+
+## 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/CalvertYang/EInvoice-QR-Encryptor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 'einvoice-qr-encryptor'
+
+# 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/einvoice-qr-encryptor.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'einvoice-qr-encryptor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'einvoice-qr-encryptor'
+  spec.version       = EInvoiceQREncryptor::VERSION
+  spec.authors       = ['Calvert']
+  spec.email         = ['']
+
+  spec.summary       = 'E-Invoice QR code information encryptor'
+  spec.description   = 'Encrypt, decrypt and generate QR code information for einvoice(Taiwan)'
+  spec.homepage      = 'https://github.com/calvertyang/EInvoice-QR-Encryptor'
+  spec.license       = 'MIT'
+
+  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.required_ruby_version = '>= 2.1.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.47.1'
+  spec.add_development_dependency 'simplecov', '~> 0.13.0'
+end

data/lib/einvoice-qr-encryptor.rb

@@ -0,0 +1,5 @@
+require 'einvoice-qr-encryptor/version'
+require 'einvoice-qr-encryptor/client'
+
+module EInvoiceQREncryptor # :nodoc:
+end

data/lib/einvoice-qr-encryptor/client.rb

@@ -0,0 +1,166 @@
+require 'openssl'
+require 'base64'
+require 'einvoice-qr-encryptor/error_message'
+require 'einvoice-qr-encryptor/core_ext/integer'
+
+module EInvoiceQREncryptor
+  class Cipher # :nodoc:
+    attr_reader :aes_key
+
+    def initialize(aes_key = nil)
+      @aes_key = aes_key
+      @aes_iv = '0EDF25C93A28D7B5FF5E45DA42F8A1B8'
+      @cipher = OpenSSL::Cipher::AES.new(128, :CBC)
+    end
+
+    # Encrypt plain text
+    #
+    # @param plain_text [String] Plain text to encrypt
+    # @return [String] Cipher text
+    # @example
+    #   encrypt('AA123456781234') #=> '73UqXrAk5DsVNv2VEvIFkQ=='
+    def encrypt(plain_text)
+      init_cipher(:encrypt)
+      Base64.encode64(@cipher.update(plain_text) + @cipher.final).strip
+    end
+
+    # Decrypt cipher text
+    #
+    # @param cipher_text [String] Cipher text to decrypt
+    # @return [String] Plain text
+    # @example
+    #   decrypt('73UqXrAk5DsVNv2VEvIFkQ==') #=> 'AA123456781234'
+    def decrypt(cipher_text)
+      init_cipher(:decrypt)
+      @cipher.update(Base64.decode64(cipher_text)) + @cipher.final
+    end
+
+    # Generate QR code information for invoice
+    #
+    # @param invoice_number [String]
+    # @param invoice_date [String]
+    # @param invoice_time [String]
+    # @param random_number [String]
+    # @param sales_amount [Integer]
+    # @param tax_amount [Integer]
+    # @param total_amount [Integer]
+    # @param buyer_identifier [String]
+    # @param represent_identifier [String]
+    # @param seller_identifier [String]
+    # @param business_identifier [String]
+    # @param product_arrays [Array]
+    # @return [String] QR code information for invoice
+    # @example
+    #   gen_qrcode_information(
+    #     invoice_number: 'AA12345678',
+    #     invoice_date: '1040511',
+    #     invoice_time: '090000',
+    #     random_number: '1234',
+    #     sales_amount: 100,
+    #     tax_amount: 0,
+    #     total_amount: 100,
+    #     buyer_identifier: '00000000',
+    #     represent_identifier: '00000000',
+    #     seller_identifier: '00000000',
+    #     business_identifier: '00000000',
+    #     product_array: []
+    #   ) #=> 'AA12345678104051112340000006400000064000000000000000073UqXrAk5DsVNv2VEvIFkQ=='
+    def gen_qrcode_information(invoice_number:, invoice_date:, invoice_time:, random_number:, sales_amount:, tax_amount:, total_amount:, buyer_identifier:, represent_identifier:, seller_identifier:, business_identifier:, product_array:)
+      # check all arguments are valid
+      # 發票字軌號碼共 10 碼
+      raise ErrorMessage.generate(msg: :field_should_be, field: :invoice_number, data: String) unless invoice_number.is_a? String
+      raise ErrorMessage.generate(msg: :fixed_length, field: :invoice_number, length: 10) if invoice_number.length != 10
+
+      # 發票開立年月日(中華民國年份月份日期)共 7 碼
+      raise ErrorMessage.generate(msg: :field_should_be, field: :invoice_date, data: String) unless invoice_date.is_a? String
+      raise ErrorMessage.generate(msg: :fixed_length, field: :invoice_date, length: 7) if invoice_date.length != 7
+
+      /\d{3}(?<month>\d{2})(?<day>\d{2})/ =~ invoice_date
+      raise ErrorMessage.generate(msg: :field_should_be, field: 'month of invoice_date', data: 'between 01 ~ 12') unless ('01'..'12').cover? month
+      raise ErrorMessage.generate(msg: :field_should_be, field: 'day of invoice_date', data: 'between 01 ~ 31') unless ('01'..'31').cover? day
+
+      # 發票開立時間 (24 小時制) 共 6 碼，以時時分分秒秒方式之字串表示
+      # raise ErrorMessage.generate(msg: :field_should_be, field: :invoice_time, data: String) unless invoice_time.is_a? String
+      # raise ErrorMessage.generate(msg: :fixed_length, field: :invoice_time, length: 6) if invoice_time.length != 6
+
+      # 4 位隨機碼
+      raise ErrorMessage.generate(msg: :field_should_be, field: :random_number, data: String) unless random_number.is_a? String
+      raise ErrorMessage.generate(msg: :fixed_length, field: :random_number, length: 4) if random_number.length != 4
+
+      # 銷售額(未稅)
+      raise ErrorMessage.generate(msg: :field_should_be, field: :sales_amount, data: Integer) unless sales_amount.is_a? Integer
+      raise ErrorMessage.generate(msg: :field_should_be, field: :sales_amount, data: 'greater than or equal to 0') if sales_amount < 0
+
+      # 稅額
+      raise ErrorMessage.generate(msg: :field_should_be, field: :tax_amount, data: Integer) unless tax_amount.is_a? Integer
+      raise ErrorMessage.generate(msg: :field_should_be, field: :tax_amount, data: 'greater than or equal to 0') if tax_amount. < 0
+
+      # 總計金額(含稅)
+      raise ErrorMessage.generate(msg: :field_should_be, field: :total_amount, data: Integer) unless total_amount.is_a? Integer
+      raise ErrorMessage.generate(msg: :field_should_be, field: :total_amount, data: 'greater than or equal to 0') if total_amount. < 0
+
+      # 買受人統一編號
+      raise ErrorMessage.generate(msg: :field_should_be, field: :buyer_identifier, data: String) unless buyer_identifier.is_a? String
+      raise ErrorMessage.generate(msg: :fixed_length, field: :buyer_identifier, length: 8) if buyer_identifier.length != 8
+
+      # 代表店統一編號，目前電子發票證明聯二維條碼規格已不使用代表店
+      # raise ErrorMessage.generate(msg: :field_should_be, field: :represent_identifier, data: String) unless represent_identifier.is_a? String
+      # raise ErrorMessage.generate(msg: :fixed_length, field: :represent_identifier, length: 8) if represent_identifier.length != 8
+
+      # 銷售店統一編號
+      raise ErrorMessage.generate(msg: :field_should_be, field: :seller_identifier, data: String) unless seller_identifier.is_a? String
+      raise ErrorMessage.generate(msg: :fixed_length, field: :seller_identifier, length: 8) if seller_identifier.length != 8
+
+      # 總公司統一編號，如無總公司請填入銷售店統一編號
+      raise ErrorMessage.generate(msg: :field_should_be, field: :business_identifier, data: String) unless business_identifier.is_a? String
+      raise ErrorMessage.generate(msg: :fixed_length, field: :business_identifier, length: 8) if business_identifier.length != 8
+
+      # 商品資訊
+      raise ErrorMessage.generate(msg: :field_should_be, field: :product_array, data: Array) unless product_array.is_a? Array
+
+      product_array.each do |product|
+        # 透過條碼槍所掃出之條碼資訊
+        raise ErrorMessage.generate(msg: :field_should_be, field: 'product_array.product_code', data: String) unless product[:product_code].is_a? String
+        raise ErrorMessage.generate(msg: :cannot_be_empty, field: 'product_array.product_code') if product[:product_code].empty?
+
+        # 商品名稱
+        raise ErrorMessage.generate(msg: :field_should_be, field: 'product_array.product_name', data: String) unless product[:product_name].is_a? String
+        raise ErrorMessage.generate(msg: :cannot_be_empty, field: 'product_array.product_name') if product[:product_name].empty?
+
+        # 商品數量
+        raise ErrorMessage.generate(msg: :field_should_be, field: 'product_array.product_qty', data: String) unless product[:product_qty].is_a? String
+        raise ErrorMessage.generate(msg: :cannot_be_empty, field: 'product_array.product_qty') if product[:product_qty].empty?
+
+        # 商品銷售額(整數未稅)，若無法分離稅項則記載為字串 0
+        raise ErrorMessage.generate(msg: :field_should_be, field: 'product_array.product_sale_amount', data: String) unless product[:product_sale_amount].is_a? String
+        raise ErrorMessage.generate(msg: :cannot_be_empty, field: 'product_array.product_sale_amount') if product[:product_sale_amount].empty?
+
+        # 商品稅額(整數)，若無法分離稅項則記載為字串 0
+        raise ErrorMessage.generate(msg: :field_should_be, field: 'product_array.product_tax_amount', data: String) unless product[:product_tax_amount].is_a? String
+        raise ErrorMessage.generate(msg: :cannot_be_empty, field: 'product_array.product_tax_amount') if product[:product_tax_amount].empty?
+
+        # 商品金額(整數含稅)
+        raise ErrorMessage.generate(msg: :field_should_be, field: 'product_array.product_amount', data: String) unless product[:product_amount].is_a? String
+        raise ErrorMessage.generate(msg: :cannot_be_empty, field: 'product_array.product_amount') if product[:product_amount].empty?
+      end
+
+      # generate cipher text
+      cipher_text = encrypt("#{invoice_number}#{random_number}")
+
+      # return QR Code invoice information
+      "#{invoice_number}#{invoice_date}#{random_number}" \
+      "#{sales_amount.to_8bit_hex_string}#{total_amount.to_8bit_hex_string}" \
+      "#{buyer_identifier}#{seller_identifier}#{cipher_text}"
+    end
+
+    private
+
+    def init_cipher(type)
+      raise ErrorMessage.generate(msg: :cannot_be_empty, field: :aes_key) if @aes_key.nil? || @aes_key.empty?
+
+      @cipher.send(type)
+      @cipher.key = [@aes_key].pack('H*')
+      @cipher.iv = [@aes_iv].pack('H*')
+    end
+  end
+end

data/lib/einvoice-qr-encryptor/core_ext/integer.rb

@@ -0,0 +1,9 @@
+class Integer # :nodoc:
+  # Convert integer to 8-bit hexadecimal
+  #
+  # @example
+  #   100.to_8bit_hex_string #=> "00000064"
+  def to_8bit_hex_string
+    to_s(16).rjust(8, '0')
+  end
+end

data/lib/einvoice-qr-encryptor/error_message.rb

@@ -0,0 +1,14 @@
+module EInvoiceQREncryptor
+  class ErrorMessage # :nodoc:
+    def self.generate(params)
+      case params[:msg]
+      when :field_should_be
+        "The #{params[:field]} should be #{params[:data]}"
+      when :fixed_length
+        "The length for #{params[:field]} should be #{params[:length]}"
+      when :cannot_be_empty
+        "The #{params[:field]} cannot be empty"
+      end
+    end
+  end
+end

data/lib/einvoice-qr-encryptor/version.rb

@@ -0,0 +1,3 @@
+module EInvoiceQREncryptor
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: einvoice-qr-encryptor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Calvert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: Encrypt, decrypt and generate QR code information for einvoice(Taiwan)
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- einvoice-qr-encryptor.gemspec
+- lib/einvoice-qr-encryptor.rb
+- lib/einvoice-qr-encryptor/client.rb
+- lib/einvoice-qr-encryptor/core_ext/integer.rb
+- lib/einvoice-qr-encryptor/error_message.rb
+- lib/einvoice-qr-encryptor/version.rb
+homepage: https://github.com/calvertyang/EInvoice-QR-Encryptor
+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.1.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: E-Invoice QR code information encryptor
+test_files: []