blacksheep 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5e39f0b5524839016bc9a6811e51257f49a2d5f00cf42d3d9fe07ab01de6b602
+  data.tar.gz: c0d169df550b722a11ffa2aaf7ea0ef5657f3c64ad5f7b8b6ac2c10419ba7ef0
+SHA512:
+  metadata.gz: 589637c6979dbaebe1756f95ebe0038a7b707059b4a809f56d1d6575bbd4b5e2f8822bb54815e93491f0517b22a71ccb06d690da05b5396ea30fbe6c9acabb59
+  data.tar.gz: b12064a64112255dc2b75aacf1a3ff2245131c96ccd5a12a863242e5642c10d97096f19010981c97b53940a905988bffd04508d77f337846e24dded666e874de

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.6
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in blacksheep.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    blacksheep (0.1.0)
+      dry-matcher
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    dry-core (0.5.0)
+      concurrent-ruby (~> 1.0)
+    dry-matcher (0.9.0)
+      dry-core (~> 0.4, >= 0.4.8)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  blacksheep!
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Martin Schweizer
+
+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,39 @@
+# Blacksheep
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/blacksheep`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blacksheep'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blacksheep
+
+## 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/verticonaut/blacksheep.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "blacksheep"
+
+# 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/blacksheep.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "blacksheep/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "blacksheep"
+  spec.version       = Blacksheep::VERSION
+  spec.authors       = ["Martin Schweizer"]
+  spec.email         = ["martin.schweizer6@bluewin.ch"]
+
+  spec.summary       = %q{Support for API acrtions}
+  spec.description   = %q{…includes errorhandling and json transformer}
+  spec.homepage      = "http://verticonaut.me"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    # spec.metadata["source_code_uri"] = "Put your gem's public repo URL here."
+    # spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/blacksheep.rb

@@ -0,0 +1,16 @@
+require "blacksheep/version"
+require "blacksheep/json_meta"
+require "blacksheep/json_result"
+require "blacksheep/action_decorator"
+require "blacksheep/decorators/default_error_handler"
+require "blacksheep/decorators/json_transformer"
+require "blacksheep/decorators/result_matcher"
+require "blacksheep/action"
+require "blacksheep/version"
+
+
+
+module Blacksheep
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/blacksheep/action.rb

@@ -0,0 +1,65 @@
+module Blacksheep
+  # Transoformes key in object structures in different caseing (snake_case, pascal_case cucrrently)
+  #
+  # @example
+  #   params = {
+  #     attr: 1,
+  #     _case: 'camel'
+  #   }
+  #
+  #   result_in_camel_case = Blacksheep::JsonTransformer.new(params).process_transformed do |converted_params_in_snake_case|
+  #     do_something_with(converted_params_in_snake_case)
+  #     #…
+  #   end
+  #
+  #   …alternative
+  #   transformer = Blacksheep::JsonTransformer.new(params)
+  #   converted_params_in_snake_case = transformer.transformed_params
+  #   ...
+  #   result = do_something_with(converted_params_in_snake_case)
+  #   result_in_camel_case = transformer.transform_result(result)
+  #
+  # @class Blacksheep::Action
+  class Action
+    attr_reader :params, :current_user, :options
+
+    class << self
+      def decorators
+        @@decorators ||= []
+      end
+
+      def add_decorator(decorator)
+        decorators << decorator
+      end
+
+      def new(*)
+        instance = super
+
+        decorators.each do |decorator|
+          instance = decorator.new(instance)
+        end
+
+        instance
+      end
+    end
+
+    def call(params, current_user: nil, **options)
+      @params = params
+      @current_user = current_user
+      @options = options
+    end
+
+    def perform(params, current_user: nil, **options, &block)
+      @params = params
+      @current_user = current_user
+      @options = options
+
+      block.call(params)
+    end
+
+    def json_result(json, status: :ok)
+      JsonResult.new(json, status)
+    end
+
+  end
+end

data/lib/blacksheep/action_decorator.rb

@@ -0,0 +1,9 @@
+require 'delegate'
+
+module Blacksheep
+  class ActionDecorator < SimpleDelegator
+    def class
+      __getobj__.class
+    end
+  end
+end

data/lib/blacksheep/decorators/default_error_handler.rb

@@ -0,0 +1,94 @@
+module Blacksheep
+  module Decorators
+    # @class Blacksheep::Decorators::DefaultErrorHandler
+    class DefaultErrorHandler < ActionDecorator
+
+      def call(*)
+        puts error_handler: "*" * 50
+        super
+      rescue => exception
+        handle(exception)
+      end
+
+      def perform(*)
+        super
+      rescue => exception
+        handle(exception)
+      end
+
+      def handle(exception)
+        json = status = nil
+
+        # case exception
+        #   when Exceptions::ValidationException
+        #     errors = []
+        #     exception.model.errors.each do |attribute, message|
+        #       errors << {
+        #         title:  "'#{attribute}' validation error",
+        #         detail: message,
+        #       }
+        #     end
+        #     json = {
+        #       errors: errors
+        #     }
+        #     status = :unprocessable_entity # 422
+        #   when Pundit::NotAuthorizedError
+        #     json = {
+        #       errors: [
+        #         pointer: {
+        #           source: not_authorized_pointer(exception)
+        #         },
+        #         title: "#{exception.class}",
+        #         detail: "#{exception.message}",
+        #       ]
+        #     }
+        #     status = :unauthorized # 401
+        #   when Exceptions::AuthenticationInvalid
+        #     json = {
+        #       errors: [
+        #         pointer: {
+        #           source: 'Secured Module'
+        #         },
+        #         title: "#{exception.class}",
+        #         detail: "#{exception.message}",
+        #       ]
+        #     }
+        #     status = :unauthorized # 401
+        #   else
+        #     json = {
+        #       errors: [
+        #         pointer: {
+        #           source: 'Internal'
+        #         },
+        #         title: "#{exception.class}",
+        #         detail: "#{exception.message}",
+        #       ]
+        #     }
+        #     status = :internal_server_error # 500
+        # end
+
+        json = {
+          errors: [
+            pointer: {
+              source: 'Internal'
+            },
+            title: "#{exception.class}",
+            detail: "#{exception.message}",
+          ]
+        }
+        status = :internal_server_error # 500
+
+        JsonResult.new(json, status)
+      end
+
+      # def not_authorized_pointer(exception)
+      #   if exception.record
+      #     "#{record.class}.find #{record.id}"
+      #   else
+      #     exception.message
+      #   end
+      # end
+
+    end
+  end
+end

data/lib/blacksheep/decorators/json_transformer.rb

@@ -0,0 +1,126 @@
+module Blacksheep
+  module Decorators
+    # @class Blacksheep::Decorators::JsonTransformer
+    class JsonTransformer < ActionDecorator
+
+      attr_reader :case, :params
+
+      def call(params, **options)
+        puts transformer: "*" * 50
+        detect_case(params)
+
+        transformed_params = self.transformed_params(params)
+
+        json = super(transformed_params, **options)
+
+        transformed_json = transform_result(json)
+
+        JsonResult.new(transformed_json, :ok)
+      end
+
+      def perform(params, current_user: nil, **options, &block)
+        detect_case(params)
+
+        transformed_params = self.transformed_params(params)
+
+        json = block.call(transformed_params)
+        transformed_json = transform_result(json)
+
+        JsonResult.new(transformed_json, :ok)
+      end
+
+
+      #
+      # Transform the params in the instance into snake_case - if detected - from source.
+      #
+      # @return [Array, Hash] The params converted into snake_case
+      # @see #snakecase_keys
+      def transformed_params(params)
+        case @case
+          when 'snake', 'as_is'
+            params
+          when 'camel'
+            snakecase_keys(params)
+          else
+            raise Blackseep::Error, "unknown_case #{@case}"
+        end
+      end
+
+      #
+      # Transform the obj with key in snake_case to the source case.
+      # NOTE: leading underscored are preserved (e.g. _my_laptop => _myLaptop)
+      #
+      # @param obj [Array, Hash] A result structure
+      # @return [Array, Hash] The rsult structure with keys converted to source caseing
+      # @see #camelize_keys
+      def transform_result(obj)
+        case @case
+          when 'snake', 'as_is'
+            obj
+          when 'camel'
+            camelize_keys(obj)
+          else
+            raise Blackseep::Error, "unknown_case #{@case}"
+        end
+      end
+
+      #
+      # Make all keys in the passed object snake_case
+      #
+      # @param obj [Array, Hash] …
+      # @return [Array, Hash] The source obj with kyes transformed into snake_case
+      def snakecase_keys(obj)
+        deep_transform_keys(obj) { |k| k.to_s.underscore.to_sym }.with_indifferent_access
+      end
+
+      #
+      # Camlize keys - but keep leading underscores
+      #
+      # @param obj [Array, hash] …
+      # @return [Array, Hash] The passed in obj with keys transferred to camel_case.
+      def camelize_keys(obj)
+        deep_transform_keys(obj) { |k|
+          key = k.to_s
+          match = key.match(/^(?<underscores>_*)(?<attribute>\w*)/)
+          converted = match[:attribute].camelize(:lower)
+
+          match[:underscores].present? ? "#{match[:underscores]}#{converted}" : converted
+        }
+      end
+
+      private
+
+      def detect_case(params)
+        @params ||= params
+        @case ||= params ? params.fetch(:_case, 'as_is').to_s : 'as_is'
+
+        @case
+      end
+
+      #
+      # Deep transform the keys in the obj structure as descibed in the block passed
+      #
+      # @param obj [Array, Hash] …
+      # @yield key [String] A block transforming the key passed into
+      # @yield_param key [String, Symbol] The key to be transformed
+      # @yield_return [String] The transfomed key
+      # @return [Array, Hash] The obj structure with transformed keys.
+      def deep_transform_keys(obj, &block)
+        case obj
+          when  Hash, ActionController::Parameters
+            res = {}.with_indifferent_access
+            obj.each do |key, value|
+              res[yield(key)] = deep_transform_keys(value, &block)
+            end
+            res
+          when Array
+            obj.map{ |each| deep_transform_keys(each, &block) }
+          else
+            obj
+        end
+      end
+
+
+    end
+  end
+end

data/lib/blacksheep/decorators/localizer.rb

@@ -0,0 +1,30 @@
+module Blacksheep
+  module Decorators
+
+    # @class Blacksheep::Decorators::Localozer
+    class Localizer < ActionDecorator
+
+      def call(params, **)
+        if (locale = params[:_locale])
+          I18n.with_locale(locale) do
+            super
+          end
+        else
+          super
+        end
+      end
+
+      def perform(params, **)
+        if (locale = params[:_locale])
+          I18n.with_locale(locale) do
+            super
+          end
+        else
+          super
+        end
+      end
+
+    end
+
+  end
+end

data/lib/blacksheep/decorators/result_matcher.rb

@@ -0,0 +1,44 @@
+require "dry-matcher"
+
+module Blacksheep
+  module Decorators
+    # @class Blacksheep::Decorators::ResultMatcher
+    class ResultMatcher < ActionDecorator
+      Matcher = -> {
+        # Match `json_result` with status :ok for success
+        success_case = Dry::Matcher::Case.new do |json_result, _|
+          if json_result.success?
+            json_result
+          else
+            # this is a constant from dry/core/constants
+            Dry::Matcher::Undefined
+          end
+        end
+
+        # Match `json_result` with status not :ok` for failure - other status' can be distinguished
+        failure_case = Dry::Matcher::Case.new do |json_result, patterns|
+          if !json_result.success! && (patterns.empty? || patterns.include?(json_result.status))
+            value
+          else
+            Dry::Matcher::Undefined
+          end
+        end
+
+        # Build the matcher
+        Dry::Matcher.new(success: success_case, failure: failure_case)
+      }.call
+
+      include Dry::Matcher.for(:call, with: Matcher)
+
+      def call(*)
+        puts matcher: "*" * 50
+        super
+      end
+
+      def perform(*)
+        raise Blackseep::Error, 'JsonResultMatcher does not support #perform'
+      end
+
+    end
+  end
+end

data/lib/blacksheep/json_meta.rb

@@ -0,0 +1,41 @@
+module Blacksheep
+  class JsonMeta
+
+    attr_reader :json
+
+    def initialize(json = {})
+      @json = json
+    end
+
+    class << self
+      def success(title: nil, detail: nil)
+        new.success(title: title, detail: detail)
+      end
+    end
+
+    def success(title: nil, detail: nil)
+      result = {
+        success: true,
+      }
+
+      if title.present?
+        result[:title] = title
+      elsif detail.present?
+        result[:title] = 'Success'
+      end
+
+      result[:detail] = detail if detail.present?
+
+      json[:result] = result
+
+      self
+    end
+
+    def as_json
+      {
+        jsonMeta: json
+      }
+    end
+
+  end
+end

data/lib/blacksheep/json_result.rb

@@ -0,0 +1,43 @@
+module Blacksheep
+  class JsonResult
+
+    attr_reader :json, :status
+
+    def initialize(json, status)
+      @json = json
+      @status = status
+    end
+
+    def set_json(value)
+      @json = value
+
+      self
+    end
+
+    def set_status(value)
+      @status = value
+
+      self
+    end
+
+    def success?
+      @status == :ok
+    end
+
+    def render(json_wrap: 'data')
+      {
+        json:   wrap(json, json_wrap: json_wrap),
+        status: status
+      }
+    end
+
+    private
+
+    def wrap(json, json_wrap:)
+      wrap = success? ? json_wrap : nil
+
+      wrap.present? ? { wrap => json } : json
+    end
+
+  end
+end

data/lib/blacksheep/version.rb

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

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: blacksheep
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Schweizer
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-17 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: "…includes errorhandling and json transformer"
+email:
+- martin.schweizer6@bluewin.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blacksheep.gemspec
+- lib/blacksheep.rb
+- lib/blacksheep/action.rb
+- lib/blacksheep/action_decorator.rb
+- lib/blacksheep/decorators/default_error_handler.rb
+- lib/blacksheep/decorators/json_transformer.rb
+- lib/blacksheep/decorators/localizer.rb
+- lib/blacksheep/decorators/result_matcher.rb
+- lib/blacksheep/json_meta.rb
+- lib/blacksheep/json_result.rb
+- lib/blacksheep/version.rb
+homepage: http://verticonaut.me
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://verticonaut.me
+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.8
+signing_key:
+specification_version: 4
+summary: Support for API acrtions
+test_files: []