blood_contracts-core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d50ef9d60bc174f486385734c98d18ade0fa6a21cdc809d0a3bead98c044aac
+  data.tar.gz: c55c10f1248097678f6feaab0bfd055494c2de7da69b663ec2458b9449b8b560
+SHA512:
+  metadata.gz: 469b03faa75fa6a46448aee7592cbbabe2a4ad53c5dca11c7395e67a9fdfcfc6c4bc4364afde47440778befaf78344f856b65f3b6c1ad0c267d1943629152c53
+  data.tar.gz: 4354966854dc2cacaf189fec6531555e5f5784b915e34757db40d896fd095f9666a58b62dacd00874b41b467557abf0fd83dc6fdd7395a0d2353b154e4e5ba46

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sclinede@evilmartians.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Sergey Dolganov
+
+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,42 @@
+# BloodContracts::Core
+
+Simple implementation of Refinement Types and Contract (based on types).
+Would be the basement for the BloodContracts API production testing framework.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blood_contracts-core'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blood_contracts-core
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/sclinede/blood_contracts-core. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BloodContracts::Core project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sclinede/blood_contracts-core/blob/master/CODE_OF_CONDUCT.md).

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 "blood_contracts/core"
+
+# 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/blood_contracts-core.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "blood_contracts/core/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "blood_contracts-core"
+  spec.version       = BloodContracts::Core::VERSION
+  spec.authors       = ["Sergey Dolganov"]
+  spec.email         = ["sclinede@evilmartians.com"]
+
+  spec.summary       = %q{Core classes for Contracts API validation}
+  spec.description   = %q{Core classes for Contracts API validation}
+  spec.homepage      = "https://github.com/sclinede/blood_contracts-core"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin/"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "dry-initializer", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/examples/json_response.rb

@@ -0,0 +1,92 @@
+require 'json'
+require 'blood_contracts/core'
+
+module Types
+  class JSON < BloodType
+    param :json_string
+
+    def match
+      @parsed = ::JSON.parse(unpack_refined(json_string))
+      self
+    rescue StandardError => error
+      @errors << error
+      self
+    end
+
+    def unpack
+      @parsed
+    end
+  end
+
+  class Tariff < BloodType
+    param :json
+
+    def match
+      super do
+        @parsed = unpack_refined(self.json).slice("cost", "cur").compact
+        @errors << :not_a_tariff if @parsed.size != 2
+        self
+      end
+    end
+  end
+
+  class Error < BloodType
+    param :json
+
+    def match
+      super do
+        @parsed = unpack_refined(self.json).slice("code", "message").compact
+        @errors << :not_an_error if @parsed.size != 2
+        self
+      end
+    end
+  end
+
+  class Response < BloodType
+    option :raw, BC::Anything.method(:new)
+    option :parsed, JSON.method(:new), default: -> { raw }
+    option :mapped, (Tariff | Error).method(:new), default: -> { parsed }
+  end
+end
+
+def match_response(response)
+  case (match = Types::Response.match(raw: response))
+  when BC::ContractFailure
+    puts "Honeybadger.notify 'Unexpected behavior in Russian Post', context: #{match.context}"
+    puts "render json: { errors: 'Ooops! Not working, we've been notified. Please, try again later' }"
+
+    return unless ENV["RAISE"]
+    match.errors.values.flatten.find do |v|
+      raise v if StandardError === v
+    end
+  when Types::Tariff
+    # работаем с тарифом
+    puts "render json: { tariff: #{match.unpack.mapped} }"
+  when Types::Error
+    # работаем с ошибкой, e.g. адрес слишком длинный
+    puts "render json: { errors: [#{match.unpack.mapped.unpack['message']}] } }"
+  else
+    binding.irb
+  end
+end
+
+puts "#{'=' * 20}================================#{'=' * 20}"
+puts "\n\n\n"
+puts "#{'=' * 20} WHEN VALID RESPONSE:           #{'=' * 20}"
+valid_response = '{"cost": 1000, "cur": "RUB"}'
+match_response(valid_response)
+puts "#{'=' * 20}================================#{'=' * 20}"
+
+
+puts "\n\n\n"
+puts "#{'=' * 20} WHEN KNOWN API ERROR RESPONSE: #{'=' * 20}"
+error_response = '{"code": 123, "message": "Too Long Address"}'
+match_response(error_response)
+puts "#{'=' * 20}================================#{'=' * 20}"
+
+
+puts "\n\n\n"
+puts "#{'=' * 20} WHEN UNEXPECTED RESPONSE:      #{'=' * 20}"
+invalid_response = '<xml>'
+match_response(invalid_response)
+puts "#{'=' * 20}================================#{'=' * 20}"

data/lib/blood_contracts-core.rb

@@ -0,0 +1 @@
+require_relative "./blood_contracts/core"

data/lib/blood_contracts/core.rb

@@ -0,0 +1,30 @@
+require "dry-initializer"
+require_relative "./core/contract.rb"
+require_relative "./core/type.rb"
+require_relative "./core/version.rb"
+
+BloodContract = BloodContracts::Core::Contract
+BloodType = BloodContracts::Core::Type
+
+module BloodContracts
+  module Core; end
+
+  class ContractFailure < Core::Type
+    def errors
+      context[:errors].to_h
+    end
+
+    def unpack
+      context
+    end
+  end
+
+  class Anything < Core::Type
+    param :data
+  end
+end
+
+module BC
+  Anything = BloodContracts::Anything
+  ContractFailure = BloodContracts::ContractFailure
+end

data/lib/blood_contracts/core/contract.rb

@@ -0,0 +1,18 @@
+module BloodContracts
+  module Core
+    class Contract
+      class << self
+        attr_accessor :input_type, :output_type
+      end
+
+      def self.call(*args)
+        if (input_match = input_type.match(*args)).valid?
+          result = yield(input_match)
+          output_type.match(result, context: input_match.context)
+        else
+          input_match
+        end
+      end
+    end
+  end
+end

data/lib/blood_contracts/core/type.rb

@@ -0,0 +1,197 @@
+module BloodContracts
+  module Core
+    class Type
+      extend Dry::Initializer
+
+      # TODO: share context between Refinement Types match
+      class << self
+        def attributes
+          @attributes ||= []
+        end
+
+        def param(name, *)
+          @attributes = attributes | [name.to_sym]
+          super
+        end
+
+        def option(name, type = nil, as: name, **)
+          @attributes = attributes | [as.to_sym]
+          super
+        end
+
+        def single?
+          attributes.size <= 1
+        end
+
+        attr_reader :sum
+        def or_a(other_type)
+          c = Class.new(Anything)
+          c.instance_variable_set(
+            :@sum, Set.new([self] + self.sum.to_a << other_type)
+          )
+          c
+        end
+        alias :or_an :or_a
+        alias :| :or_a
+
+        def match(*args)
+          new(*args).match
+        end
+        alias :call :match
+
+        def ===(object)
+          return true if (result = super)
+          return result unless object.class < BloodContracts::Core::Type
+          if object.class.send(:single?)
+            return result if object.class.sum.to_a.empty?
+            return object.class.sum.any? { |or_type| self == or_type }
+          end
+
+          object.attributes.values.any? { |sub_type| self === sub_type }
+        end
+      end
+
+      attr_accessor :context
+      attr_reader :errors, :value_handler
+      def initialize(*args, **kwargs)
+        @errors = []
+        @context = kwargs.delete(:context) || {}
+        @value_handler = self.class.single? ? Single.new(self) : Tuple.new(self)
+
+        super(*args, **kwargs)
+      end
+
+      def attributes
+        @attributes ||= self.class.dry_initializer.attributes(self)
+      end
+
+      def match
+        return @match if defined? @match
+        return @match = yield if block_given?
+        @match = value_handler.match
+      end
+      alias :call :match
+
+      def valid?
+        value_handler.valid?
+      end
+      def invalid?; !valid?; end
+
+      def unpack
+        value_handler.unpack
+      end
+
+      def single?
+        Single === value_handler
+      end
+
+      def refined?(object)
+        BloodContracts::Core::Type === object
+      end
+
+      def unpack_refined(value)
+        refined?(value) ? value.unpack : value
+      end
+
+      protected
+
+      class ValueHandler
+        def initialize(subject)
+          @subject = subject
+        end
+
+        def errors_by_type(matches)
+          Hash[
+            matches.map(&:class).zip(matches.map(&:errors))
+          ].delete_if { |_, errors| errors.empty? }
+        end
+
+        def refined?(object)
+          @subject.refined?(object)
+        end
+
+        def unpack_refined(value)
+          @subject.unpack_refined(value)
+        end
+      end
+
+      class Tuple < ValueHandler
+        def initialize(*)
+          super
+          @wrapper = Struct.new(*@subject.class.attributes, keyword_init: true)
+        end
+
+        def wrap_unpacked(match)
+          @wrapper.new(
+            match.attributes.transform_values(&method(:unpack_refined))
+          )
+        end
+
+        def match
+          failed_match =
+            @subject.attributes.values.lazy.map(&:match).find(&:invalid?)
+
+          if failed_match
+            BloodContracts::ContractFailure.new(
+              context: { errors: errors_by_type([failed_match]) }
+            )
+          else
+            @subject
+          end
+        end
+
+        def unpack
+          raise "This is not what you're looking for" if invalid?
+
+          wrap_unpacked(@subject.match)
+        end
+
+        def invalid?
+          BloodContracts::ContractFailure === @subject.match
+        end
+        def valid?; !invalid?; end
+
+        def single?
+          false
+        end
+      end
+
+      class Single < ValueHandler
+        def match
+          sum = @subject.class.sum.to_a
+          return refined?(value) ? value.match : @subject if sum.empty?
+
+          or_matches = sum.map { |type| type.match(value) }
+          if (match = or_matches.find(&:valid?))
+            match.context.merge!(errors: errors_by_type(or_matches))
+            match
+          else
+            BloodContracts::ContractFailure.new(
+              context: { errors: errors_by_type(or_matches) }
+            )
+          end
+        end
+
+        def valid?
+          @subject.errors.empty?
+        end
+
+        def unpack
+          raise "This is not what you're looking for" unless valid?
+
+          unpack_refined value
+        end
+
+        def single?
+          true
+        end
+
+        private
+
+        def value
+          @value ||= @subject.attributes.values.first
+        end
+      end
+    end
+  end
+end

data/lib/blood_contracts/core/version.rb

@@ -0,0 +1,5 @@
+module BloodContracts
+  module Core
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: blood_contracts-core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Dolganov
+autorequire: 
+bindir: bin/
+cert_chain: []
+date: 2019-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: Core classes for Contracts API validation
+email:
+- sclinede@evilmartians.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blood_contracts-core.gemspec
+- examples/json_response.rb
+- lib/blood_contracts-core.rb
+- lib/blood_contracts/core.rb
+- lib/blood_contracts/core/contract.rb
+- lib/blood_contracts/core/type.rb
+- lib/blood_contracts/core/version.rb
+homepage: https://github.com/sclinede/blood_contracts-core
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Core classes for Contracts API validation
+test_files: []