microcon 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5490ef93d83e8c638a5500d1304543f44252bdb7
+  data.tar.gz: 87adab9a51380b2c7ccdd17d52f807bcb2b6c6b1
+SHA512:
+  metadata.gz: 45ed93df32e9168ac2b72bdb45477d254ff7b3065659b8e80a96aa499c2504fe6ebfc14003cf55a7c89145098e0fd997c25d203d77b8a10509625b031d36fb99
+  data.tar.gz: 4c2c37b2ebc80139f7da84b2b26104fa9555f8e2d325e0a8fe77b6bb4279ce65ea3fd6fb2feb925fd03482a3674b3913ef79cc0d4a7d2dabb21afd448eebbee1

data/lib/microcon.rb

@@ -0,0 +1,18 @@
+require 'dry-monads'
+require 'rack/request'
+require 'oj'
+require 'transproc'
+require 'dry-container'
+require 'adts'
+
+require 'microcon/functions'
+require 'microcon/request'
+require 'microcon/response'
+require 'microcon/contextualizer'
+require 'microcon/result_types'
+require 'microcon/result_handlers'
+require 'microcon/controller'
+
+Oj.default_options = { symbol_keys: true, indent: 2,
+  mode: :compat, bigdecimal_as_decimal: true,
+  quirks_mode: false }

data/lib/microcon/contextualizer.rb

@@ -0,0 +1,35 @@
+module Microcon
+  module Contextualizer
+
+  def self.included(klass)
+    unless klass.instance_variable_defined? :@contextualizers
+      klass.instance_variable_set :@contextualizers, []
+    end
+    klass.extend Dry::Monads::Either::Mixin
+    klass.include Dry::Monads::Either::Mixin
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    attr_accessor :contextualizers
+
+    def included(klass)
+      if klass.instance_variable_defined? :@contextualizers
+        current = klass.instance_variable_get :@contextualizers
+        updated = current + @contextualizers
+        klass.instance_variable_set :@contextualizers, updated
+      end
+    end
+
+    def contextualize_with(&blk)
+      @contextualizers << blk
+    end
+
+    def inherited(klass)
+      klass.instance_variable_set :@contextualizers, @contextualizers
+    end
+
+  end
+end
+end

data/lib/microcon/controller.rb

@@ -0,0 +1,76 @@
+module Microcon
+
+    class Controller
+
+      #@@contextualizers = []
+
+      include Microcon::Contextualizer
+
+      def call(env)
+        #binding.pry
+        #F . parse . contextualize . process . call(env)
+        result = parse(env)
+          .bind {|req| self.class.contextualize(req) }
+          .fmap {|context| self.class.process(context) }
+          .value
+        unless result.is_a?(Result)
+          raise "#{result.class} is not a valid result type. Should be a Result object"
+        end
+        render(result)
+      end
+
+      def self.process_with(handler = nil, &blk)
+        @processor = handler.nil? ? blk : handler
+      end
+
+      def self.call(env)
+        self.new.call(env)
+      end
+
+      def self.process(context)
+        @processor.call(context)
+      end
+
+      private
+
+      def parse(env)
+        Dry::Monads::Right Request.new(env)
+      rescue Oj::ParseError
+        Dry::Monads::Left Result::Error::BadRequest()
+      end
+
+      def self.contextualize(req)
+        # TODO this can be a single loop
+        context_parts = self.contextualizers.map do |contextualizer|
+          ctr = contextualizer.call **req.to_h
+          if ctr.is_a?(Result)
+            return Dry::Monads::Left(ctr)
+          elsif ctr.is_a?(Hash)
+            next Dry::Monads::Right(ctr)
+          else
+            raise "#{ctr.class} is not a valid return type for a contextualizer. Must be a Result or a Hash"
+          end
+        end
+        context_parts.reduce(Dry::Monads::Maybe({})) do |memo, obj|
+          # merge_fn = Dry::Monads::Maybe(-> x,y {x.merge(y)})
+          # merge_fn * memo * obj
+          #binding.pry
+          memo.bind {|m| obj.fmap {|o| m.merge(o)} }
+        end
+      end
+
+      def render(result)
+        # TODO check it's not nil
+        interpreted_result = ResultHandlers[result.class].call(result)
+        Response.new(**interpreted_result).to_rack
+      rescue Dry::Container::Error => e
+        raise "ResultHandlers cannot convert a #{result.class} to an HTTP response"
+      end
+
+      def process(context)
+        raise "You must implement the context method for the controller"
+      end
+
+    end
+
+end

data/lib/microcon/functions.rb

@@ -0,0 +1,8 @@
+module Microcon
+  module Functions
+    extend Transproc::Registry
+    # import all singleton methods from a module/class
+    import Transproc::HashTransformations
+    import Transproc::ArrayTransformations
+  end
+end

data/lib/microcon/request.rb

@@ -0,0 +1,45 @@
+module Microcon
+
+  class Request
+
+    attr_reader :headers, :body, :params
+
+    def initialize(env)
+      @env = env
+      @req = Rack::Request.new env
+      parse_body
+      parse_params
+      parse_headers
+    end
+
+    def to_h
+      {headers: headers, params: params, body: body}
+    end
+
+    private
+
+    def t(*args)
+      Functions[*args]
+    end
+
+    def parse_body
+      body = @req.body.read
+      parsed_body = body.empty? ? {} : Oj.load(body)
+      @body = t(:symbolize_keys)[parsed_body]
+    end
+
+    def parse_headers
+      # TODO snake case headers?
+      @headers = t(:symbolize_keys)[ @env.select {|k,v| k.start_with? 'HTTP_'}
+        .collect {|key, val| [key.sub(/^HTTP_/, '').downcase, val]}
+        .instance_eval {|hpairs| Hash[hpairs]} ]
+    end
+
+    def parse_params
+      router_params = @env['router.params'] || {} # From Hanami Router
+      @params = t(:symbolize_keys)[@req.params.merge(router_params)]
+    end
+
+
+  end
+end

data/lib/microcon/response.rb

@@ -0,0 +1,19 @@
+module Microcon
+  class Response #< BasicRequest
+
+    def initialize(status:, body: {}, headers: {})
+      @status = status
+      @body = encode(body)
+      @headers = headers.merge Rack::CONTENT_TYPE => "application/json; charset=utf-8"
+    end
+
+    def encode(body)
+      # TODO transformation
+      Oj.dump(body)
+    end
+
+    def to_rack
+      [@status, @headers, [@body]]
+    end
+  end
+end

data/lib/microcon/result_handlers.rb

@@ -0,0 +1,56 @@
+require 'dry-container'
+#Core.finalize :base_controller do
+module Microcon
+    class ResultHandlers
+
+      extend Dry::Container::Mixin
+
+      # configure do |config|
+      #   #config.registry = ->(container, key, item, options) { container[key] = item }
+      #   config.resolver = ->(container, key) {
+      #     # TODO how to use this to compose?
+      #     Some(container[key])
+      #   }
+      # end
+
+      register Result::Unauthorized, -> r {
+        { status: 401, body: {error: :unauthorized } }
+      }
+
+      register Result::Void, -> r {
+        { status: 204, body: { } }
+      }
+
+      register Result::Unprocessable, -> r {
+        {
+          status: 422,
+          body: {
+            error: :unprocessable_entity, reason: error.reason
+          }
+        }
+      }
+
+    register Result::UnprocessableWithErrors, -> r {
+        {
+          status: 422,
+          body: {
+            error: :unprocessable_entity, messages: r.errors
+          }
+        }
+    }
+
+    register Result::NotFound, -> r {
+      {status: 404, body: {error: :not_found}}
+    }
+
+
+    register Result::RecordCreated, -> r {
+      {status: 201, body: r.data}
+    }
+
+    register Result::OK, -> r {
+      {status: 200, body: r.data}
+    }
+
+    end
+  end

data/lib/microcon/result_types.rb

@@ -0,0 +1,10 @@
+Result = ADT do
+  BadRequest() | # 400
+  Unauthorized() | # 401
+  Unprocessable(reason: String) | # 422
+  UnprocessableWithErrors(errors: Hash) | # 422
+  NotFound() | # 404
+  Void() | # 204
+  RecordCreated(data: Hash) | # 201
+  OK(data: Hash) # 200
+end

data/lib/microcon/version.rb

@@ -0,0 +1,3 @@
+module Microcon
+  VERSION = '0.1'
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: microcon
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- David Peláez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: adts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.17.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.17.1
+- !ruby/object:Gem::Dependency
+  name: transproc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !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: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+description: Most JSON APIs have a limited number of respondes or outcomes. Microcon
+  tries to separate HTTP related concerns from business logic and removes most of
+  the mental clutter regarding JSON parsing, rendering and consistent API responses.
+email:
+- pelaez89@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/microcon.rb
+- lib/microcon/contextualizer.rb
+- lib/microcon/controller.rb
+- lib/microcon/functions.rb
+- lib/microcon/request.rb
+- lib/microcon/response.rb
+- lib/microcon/result_handlers.rb
+- lib/microcon/result_types.rb
+- lib/microcon/version.rb
+homepage: https://github.com/davidpelaez/microcon
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Small controller for JSON APIs
+test_files: []