fast_cqrs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abcc5e4f059bd1cc20c9692b81f7233ce609e56e624aed25b0b1ba691dee2a75
+  data.tar.gz: 1b981fb18472571726acb45024ba2f465394b2a2c37441ebd56cf7d16c0fa0be
+SHA512:
+  metadata.gz: 22e4c73a14ad9a843a87767bf898b0a001fd7179c9ffa61208724d22df8602ea2562554b65975e42e44a71cbd90e5435044053dbedde752d680c4bfbd7511362
+  data.tar.gz: 01f9aa053090e0fe01d7b063f74a7248cb2a4d4975819c413a037606df27a383b4ec31a065ca60584d5fe4e5f996af6cdbb8f9c6d3a9f009f1032db0ec886117

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/.ruby-gemset

@@ -0,0 +1 @@
+fast_cqrs

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.1

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

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 sebastian@driggl.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fast_cqrs.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    fast_cqrs (0.1.0)
+      dry-matcher
+      dry-monads
+      dry-struct
+      dry-types
+      dry-validation
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    dry-configurable (0.11.5)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-initializer (3.0.3)
+    dry-logic (1.0.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-matcher (0.8.3)
+      dry-core (>= 0.4.8)
+    dry-monads (1.3.5)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer
+    dry-schema (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.8, >= 0.8.3)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.4)
+    dry-struct (1.3.0)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-types (~> 1.3)
+      ice_nine (~> 0.11)
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.5)
+    ice_nine (0.11.2)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fast_cqrs!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sebastian Wilgosz
+
+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,105 @@
+# FastCqrs
+
+A collection of small classes allowing to implement CQRS API in ruby applications without too much of an effort.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fast_cqrs'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fast_cqrs
+
+## Usage
+
+### Transactions
+
+`FastCqrs` delivers transactions as the main piece of the request processing. A whole request processing is
+encapsulated within the transaction object, so it's easy to write unit tests for your endpoints without loading
+the whole framework while testing.
+
+Also, it's super easy to inject dependencies when needed.
+
+Basic transaction could look like this.
+
+```ruby
+   # transactions/create_article.rb
+
+  class CreateArticle < FastCqrs::Transaction
+    def call(params, **)
+      model = yield deserialize(params)
+      yield authorize(model)
+      yield create_article(model)
+      Success()
+    end
+
+    private
+
+    def deserialize(params)
+      request.call(params)
+    end
+
+    def authorize(model)
+      authorizer.call(params)
+    end
+
+    def create_article(model)
+      Try { Article.create!(model) }
+    end
+
+    def initialize
+      @authorizer = Authorizer.new
+      @request = Request.new
+    end
+  end
+```
+
+```ruby
+  # articles_controller
+
+  def create
+    Transactions::CreateArticle.new.call(params)
+  end
+
+  def create
+    Transactions::UpdateArticle.new.call(params)
+  end
+
+```
+
+### Transaction blocks
+
+Typical transaction consists of:
+
+- request - This parses the request body and modifies the input for an easy to use output.
+- authorizer - authorizes the parsed input against the given auth object
+- validator - validates the request
+- actions - methods making changes in the system.
+
+
+## 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/driggl/fast_cqrs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/driggl/fast_cqrs/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 FastCqrs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/driggl/fast_cqrs/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 "fast_cqrs"
+
+# 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/fast_cqrs.gemspec

@@ -0,0 +1,35 @@
+require_relative 'lib/fast_cqrs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fast_cqrs"
+  spec.version       = FastCqrs::VERSION
+  spec.authors       = ["Sebastian Wilgosz"]
+  spec.email         = ["sebastian@driggl.com"]
+
+  spec.summary       = %q{A lightweight CQRS scaffold for ruby-based web applications.}
+  spec.description   = %q{Write CQRS applications easily using functional endpoints without a hassle.}
+  spec.homepage      = "https://github.com/driggl/fast_cqrs"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/driggl/fast_cqrs"
+  spec.metadata["changelog_uri"] = "https://github.com/driggl/fast_cqrs/releases"
+
+  # 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        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'dry-matcher'
+  spec.add_dependency 'dry-monads'
+  spec.add_dependency 'dry-struct'
+  spec.add_dependency 'dry-types'
+  spec.add_dependency 'dry-validation'
+end

data/lib/fast_cqrs.rb

@@ -0,0 +1,8 @@
+require 'fast_cqrs/version'
+require 'fast_cqrs/authorizer'
+require 'fast_cqrs/request'
+require 'fast_cqrs/transaction'
+
+module FastCqrs
+  class Error < StandardError; end
+end

data/lib/fast_cqrs/authorizer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'dry/monads'
+
+module FastCqrs
+  class Authorizer
+    def self.inherited(klass)
+      super
+      klass.class_eval do
+        include Dry::Monads[:result, :do]
+      end
+    end
+
+    def call(**)
+      return Success() if authorize
+      fail!
+    end
+
+    protected
+
+    # Override this in the inherited class
+    def authorize
+      true
+    end
+
+    private
+
+    def fail!
+      Failure(:authorize)
+    end
+  end
+end

data/lib/fast_cqrs/deserializer/json_api.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module FastCqrs
+  module Deserializer
+    class JsonApi
+      IncorrectFormat = Class.new(StandardError)
+      HashInputRequired = Class.new(StandardError)
+
+      # Converts the json_api (https://jsonapi.org) hash resource into a flat hash
+      # (defaults to `{ data: {} }`)
+      #
+      # == Parameters:
+      # params::
+      #   A request body in form of JSON API hash with symbolized keys.
+      #
+      # == Returns:
+      # A hash with ID and all attributes flat
+      #
+      def call(params = { data: {} })
+        raise HashInputRequired unless params.is_a?(Hash)
+        raise IncorrectFormat if (data = params[:data]).blank?
+
+        attrs = data[:attributes] || {}
+
+        attrs.merge(id: data[:id], resource_type: data[:type])
+      end
+    end
+  end
+end

data/lib/fast_cqrs/request.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'dry/monads'
+
+module FastCqrs
+  class Request
+    include Dry::Monads[:result, :try]
+
+    def self.inherited(klass)
+      super
+      klass.class_eval do
+        include Dry::Monads[:result, :try]
+      end
+    end
+
+    def call(input)
+      return fail! unless (deserialized = model(input))
+
+      Success(deserialized)
+    end
+
+    protected
+
+    # overwrite this to prepare valid request object
+    def model(input)
+      return if (deserialized = deserialize(input)).error?
+
+      deserialized.value!
+    end
+
+    private
+
+    attr_reader :deserializer
+
+    def initialize(deserializer:)
+      @deserializer = deserializer
+    end
+
+    def deserialize(input)
+      Try { deserializer.call(input) }
+    end
+
+    def fail!
+      Failure(:deserialize)
+    end
+  end
+end

data/lib/fast_cqrs/transaction.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'dry/matcher/result_matcher'
+require 'dry/monads'
+require 'dry/validation'
+
+module FastCqrs
+  class Transaction
+    Dry::Validation.load_extensions(:monads)
+    def self.inherited(klass)
+      super
+      klass.class_eval do
+        include Dry::Monads[:do, :result, :try]
+        include Dry::Matcher.for(:call, with: Dry::Matcher::ResultMatcher)
+      end
+    end
+
+    def call(input, **)
+      Success()
+    end
+  end
+end

data/lib/fast_cqrs/version.rb

@@ -0,0 +1,3 @@
+module FastCqrs
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: fast_cqrs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastian Wilgosz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Write CQRS applications easily using functional endpoints without a hassle.
+email:
+- sebastian@driggl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fast_cqrs.gemspec
+- lib/fast_cqrs.rb
+- lib/fast_cqrs/authorizer.rb
+- lib/fast_cqrs/deserializer/json_api.rb
+- lib/fast_cqrs/request.rb
+- lib/fast_cqrs/transaction.rb
+- lib/fast_cqrs/version.rb
+homepage: https://github.com/driggl/fast_cqrs
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/driggl/fast_cqrs
+  source_code_uri: https://github.com/driggl/fast_cqrs
+  changelog_uri: https://github.com/driggl/fast_cqrs/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A lightweight CQRS scaffold for ruby-based web applications.
+test_files: []