czech-post-code-generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35346e06426a724537e9049903e94f172980b09b
+  data.tar.gz: a5f0bb65ddf4b096f07c31d16e5454af06cb10a6
+SHA512:
+  metadata.gz: bb6270389143706cf70a4d42e1db5cb4be9436a2e8c0298392d50e856b7d42b44e18f99efd55089deb77e6b06bf9a5eef8379eeefd2f5940a7c0fdd0beaa20e8
+  data.tar.gz: 851d1d5fce7cd9d65fc8bd99aaeb12f2626ae4342d2d7f134fe07c56149918ce15f141129f961d83f451a4c11c45d7e8e9c2ef3155103e868352d176bd6810f7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  DisplayStyleGuide: true
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+   - 'bin/*'
+
+Metrics/LineLength:
+  Max: 180
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at a.martinik@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Adam Martinik
+
+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,70 @@
+# Czech post CodeGenerator
+
+[![Build Status](https://travis-ci.org/14113/czech-post-code-generator.svg?branch=master)](https://travis-ci.org/14113/czech-post-code-generator)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```Ruby
+gem 'czech-post-code-generator'
+```
+
+And then execute:
+
+```Ruby
+$ bundle
+```
+
+Or install it yourself as:
+    
+```Ruby
+$ gem install czech-post-code-generator
+```
+
+## Usage
+
+```Ruby
+service_id = 'DR'
+order_id = 202
+client_id = 7038
+client_type = 'C'
+
+serial_number = CzechPost::CodeGenerator::SerialNumber.new(service_id, order_id, client_id, client_type).run
+```
+
+### If you have just one place for sending, you can alternative use initializer
+
+```Ruby
+# config/initializers/czech_post_code_generator.rb
+CzechPost::CodeGenerator.configure do |config|
+  config.client_id = 7039
+  config.client_type = 'D'
+end
+```
+
+```Ruby
+service_id = 'DR'
+order_id = 202
+serial_number = CzechPost::CodeGenerator::SerialNumber.new(service_id, order_id).run
+```
+
+## Documentation
+
+For more details check [documentation](https://www.ceskaposta.cz/documents/10180/282457/apost_Smluvni-podavatel_uziv_dok_v1-11.pdf) from Czech post.
+
+## 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/[USERNAME]/czech-post-code-generator. 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,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'czech/post/code/generator'
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/czech-post-code-generator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'czech_post/code_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'czech-post-code-generator'
+  spec.version               = CzechPost::CodeGenerator::VERSION
+  spec.authors               = ['Adam Martinik']
+  spec.email                 = ['a.martinik@gmail.com']
+
+  spec.summary               = 'Code generator for Czech post'
+  spec.homepage              = 'https://github.com/14113/czech-post-code-generator'
+  spec.license               = 'MIT'
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/czech_post/code_generator.rb

@@ -0,0 +1,12 @@
+module CzechPost
+  module CodeGenerator
+    def self.configuration
+      @configuration ||= CzechPost::CodeGenerator::Configuration.new
+    end
+
+    def self.configure
+      config = configuration
+      yield(config)
+    end
+  end
+end

data/lib/czech_post/code_generator/check_digit.rb

@@ -0,0 +1,57 @@
+module CzechPost
+  module CodeGenerator
+    class CheckDigit
+      DIGIT = [1, 8, 6, 4, 2, 3, 5, 9, 7].freeze # 186_423_597
+      SIZE = 8
+
+      attr_reader :order, :client_id
+
+      def initialize(order, client_id)
+        @order = order
+        @client_id = client_id
+      end
+
+      def run
+        if modulo > 1
+          11 - modulo
+        elsif modulo == 0
+          5
+        elsif modulo == 1
+          0
+        end
+      end
+
+      def valid?
+        size == SIZE
+      end
+
+      private
+
+      def get_number_by_index(index)
+        full_number.to_s[index].to_i
+      end
+
+      def times_digit
+        (0..SIZE).map do |index|
+          DIGIT[index].to_i * get_number_by_index(index)
+        end
+      end
+
+      def full_number
+        "#{client_id}#{order.id}"
+      end
+
+      def size
+        @size ||= full_number.size - 1
+      end
+
+      def sum
+        @sum ||= times_digit.inject { |a, e| a + e }
+      end
+
+      def modulo(value = 11)
+        @modulo ||= sum % value
+      end
+    end
+  end
+end

data/lib/czech_post/code_generator/configuration.rb

@@ -0,0 +1,7 @@
+module CzechPost
+  module CodeGenerator
+    class Configuration
+      attr_accessor :client_id, :client_type
+    end
+  end
+end

data/lib/czech_post/code_generator/errors/invalid_order_number_id.rb

@@ -0,0 +1,8 @@
+module CzechPost
+  module CodeGenerator
+    module Errors
+      class InvalidOrderNumberId < StandardError
+      end
+    end
+  end
+end

data/lib/czech_post/code_generator/order_number.rb

@@ -0,0 +1,28 @@
+module CzechPost
+  module CodeGenerator
+    class OrderNumber
+      MAX_SIZE = 9
+
+      attr_reader :order_id, :client_id
+
+      def initialize(order_id, client_id)
+        @order_id = order_id.to_s
+        @client_id = client_id.to_s
+        raise(CzechPost::CodeGenerator::Errors::InvalidOrderNumberId, order_id) unless valid?
+      end
+
+      def id
+        @id ||= order_id.to_s.rjust(size, '0')
+      end
+
+      def valid?
+        return false if order_id == '' || client_id == ''
+        id.length == size
+      end
+
+      def size
+        MAX_SIZE - client_id.length
+      end
+    end
+  end
+end

data/lib/czech_post/code_generator/serial_number.rb

@@ -0,0 +1,36 @@
+module CzechPost
+  module CodeGenerator
+    class SerialNumber
+      attr_reader :service_id, :order_id
+
+      def initialize(service_id, order_id, client_id = nil, client_type = nil)
+        @service_id = service_id
+        @order_id = order_id
+        @client_id = client_id
+        @client_type = client_type
+      end
+
+      def run
+        "#{service_id}#{client_id}#{order_number.id}#{check_number}#{client_type}"
+      end
+
+      private
+
+      def check_number
+        @check_number ||= CzechPost::CodeGenerator::CheckDigit.new(order_number, client_id).run
+      end
+
+      def order_number
+        @order_number ||= CzechPost::CodeGenerator::OrderNumber.new(order_id, client_id)
+      end
+
+      def client_id
+        @client_id || CzechPost::CodeGenerator.configuration.client_id
+      end
+
+      def client_type
+        @client_type || CzechPost::CodeGenerator.configuration.client_type
+      end
+    end
+  end
+end

data/lib/czech_post/code_generator/version.rb

@@ -0,0 +1,5 @@
+module CzechPost
+  module CodeGenerator
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: czech-post-code-generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Martinik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-27 00:00:00.000000000 Z
+dependencies:
+- !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: 
+email:
+- a.martinik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- czech-post-code-generator.gemspec
+- lib/czech_post/code_generator.rb
+- lib/czech_post/code_generator/check_digit.rb
+- lib/czech_post/code_generator/configuration.rb
+- lib/czech_post/code_generator/errors/invalid_order_number_id.rb
+- lib/czech_post/code_generator/order_number.rb
+- lib/czech_post/code_generator/serial_number.rb
+- lib/czech_post/code_generator/version.rb
+homepage: https://github.com/14113/czech-post-code-generator
+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.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Code generator for Czech post
+test_files: []