punk 0.0.3 → 0.2.0

data/README.md

@@ -1,9 +1,17 @@
+[![test](https://github.com/kranzky/punk/workflows/test/badge.svg)](https://github.com/kranzky/punk/actions?query=workflow%3Atest)
+[![Coverage Status](https://coveralls.io/repos/github/kranzky/punk/badge.svg?branch=main)](https://coveralls.io/github/kranzky/punk?branch=main)
 [![Gem Version](https://badge.fury.io/rb/punk.svg)](https://badge.fury.io/rb/punk)
 
 # Punk!
 
 Punk! is an omakase web framework for rapid prototyping.
 
+## Release Process
+
+1. `rake version:bump:whatever`
+2. `rake git:release BRANCH=main`
+3. Create new release on GitHub to trigger ship workflow
+
 ## Copyright
 
 Copyright (c) 2021 Jason Hutchens. See LICENSE for further details.

data/Rakefile

@@ -1,31 +1,29 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
   exit e.status_code
 end
 require 'rake'
 require 'juwelier'
 Juwelier::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
   gem.name = "punk"
   gem.homepage = "https://github.com/kranzky/punk"
-  gem.license = "UNLICENSE"
-  gem.summary = %Q{Punk! is an omakase web framework for rapid prototyping.}
-  gem.description = %Q{}
+  gem.license = "Unlicense"
+  gem.summary = "Punk! is an omakase web framework for rapid prototyping."
+  gem.description = ""
   gem.email = "lloyd@kranzky.com"
   gem.authors = ["Lloyd Kranzky"]
   gem.required_ruby_version = ">= 2.1"
-  # dependencies defined in Gemfile
 end
 Juwelier::RubygemsDotOrgTasks.new
 
 require 'yard'
 YARD::Rake::YardocTask.new
 
-task :default => :clean
+task default: :clean

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.2.0

data/app/migrations/001_lets_punk.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative '../../lib/punk/migrations/001_punk'

data/app/routes/hello.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# route: GET /hello
+PUNK.route('hello') { perform "world" }

data/bin/punk

@@ -2,7 +2,6 @@
 
 # frozen_string_literal: true
 
-require 'rubygems'
 require 'bundler/setup'
 require 'commander/import'
 require_relative '../lib/punk'

data/env/.gitignore

@@ -0,0 +1,3 @@
+production.sh
+staging.sh
+locals.sh

data/env/spec/test.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+export PUNK_TRACE=spec_test

data/env/test.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+export DATABASE_URL='postgres://localhost/punk_test'
+export MEMCACHIER_SERVERS='localhost:11211'
+export COOKIE_SECRET='20b065932a09ca10a67b02a049695177bd9b1aa75bd2cf9755e62b9a7e64daeefebec4edc2a91b2be08f7899fa9e48aca6f67d4f045d34e83213566d7dde249c'

data/lib/punk/actions/groups/list.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PUNK
+  class ListGroupsAction < Action
+    args :user, :tenant
+
+    def validate
+      validates_not_null :user
+      validates_not_empty :user
+      return if user.blank?
+      validates_not_null :tenant
+      validates_not_empty :tenant
+      return if tenant.blank?
+      validates_type User, :user
+      validates_type Tenant, :tenant
+    end
+
+    def process
+      # TODO: repository here
+      # an action takes arguments (that may be entities) and returns a view object
+      present ListGroupsView, groups: user.groups_dataset.where(tenant: tenant).all
+    end
+  end
+end

data/lib/punk/actions/sessions/clear.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module PUNK
+  class ClearSessionAction < Action
+    args :session
+
+    def validate
+      validates_not_null :session
+      validates_not_empty :session
+      return if session.blank?
+      validates_type Session, :session
+      validates_state :session, :active
+      validates_event :session, :clear
+    end
+
+    def process
+      session.clear!
+      present Info, message: "You have been logged out."
+    end
+  end
+end

data/lib/punk/actions/sessions/create.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'phony'
+
+module PUNK
+  class CreateSessionAction < Action
+    args :claim, :remote_addr, :user_agent
+
+    def validate
+      validates_not_null :claim
+      validates_not_empty :claim
+      validates_not_null :claim_type, message: "is not an email address or phone number"
+      validates_email :claim if claim_type == :email
+      validates_phone :claim if claim_type == :phone
+      validates_not_null :remote_addr
+      validates_not_empty :remote_addr
+      validates_not_null :user_agent
+      validates_not_empty :user_agent
+    end
+
+    def process
+      PUNK.db.transaction do
+        identity =
+          Identity.find_or_create(claim: _normalize_claim) do |i|
+            i.claim_type = claim_type
+          end
+        session = Session.create(identity: identity, remote_addr: remote_addr, user_agent: user_agent)
+        ChallengeClaimService.run(session: session)
+        IdentifySessionWorker.perform_async(session_id: session.id)
+        message =
+          case identity.claim_type
+          when :email
+            "We have sent a verification code to your email address. Please enter it to verify your identity."
+          when :phone
+            "We have sent a verification code to your phone number by SMS. Please enter it to verify your identity."
+          end
+        present PendingSessionView, session: session, message: message, status: 201
+      end
+    end
+
+    def claim_type
+      @claim_type ||= _guess_claim_type
+    end
+
+    private
+
+    def _guess_claim_type
+      return :email if URI::MailTo::EMAIL_REGEXP.match(claim)
+      return :phone if Phony.plausible?(claim)
+    end
+
+    def _normalize_claim
+      case claim_type
+      when :email
+        claim.downcase.strip
+      when :phone
+        phone = claim.strip
+        phone = "+1#{phone}" if phone !~ /^[+]/
+        "+#{Phony.normalize(phone)}"
+      end
+    end
+  end
+end

data/lib/punk/actions/sessions/list.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PUNK
+  class ListSessionsAction < Action
+    args :user
+
+    def validate
+      validates_not_null :user
+      validates_not_empty :user
+      return if user.blank?
+      validates_type User, :user
+    end
+
+    def process
+      present ListSessionsView, sessions: user.active_sessions.all
+    end
+  end
+end

data/lib/punk/actions/sessions/verify.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PUNK
+  class VerifySessionAction < Action
+    args :session, :secret
+
+    def validate
+      validates_not_null :session
+      validates_not_empty :session
+      return if session.blank?
+      validates_not_null :secret
+      return if secret.blank?
+      validates_type Session, :session
+      validates_state :session, :pending
+      validates_event :session, :verify
+    end
+
+    def process
+      verify = ProveClaimService.run(session: session, secret: secret)
+      raise BadRequest, 'Secret is incorrect' unless verify.result == true
+      present Info, message: 'We have succesfully verified your identity.  Welcome to GroupFire!'
+    end
+  end
+end

data/lib/punk/actions/tenants/list.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PUNK
+  class ListTenantsAction < Action
+    args :user
+
+    def validate
+      validates_not_null :user
+      validates_not_empty :user
+      return if user.blank?
+      validates_type User, :user
+    end
+
+    def process
+      present ListTenantsView, tenants: user.tenants_dataset.order(:name).all
+    end
+  end
+end

data/lib/punk/actions/users/list_group.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PUNK
+  class ListGroupUsersAction < Action
+    args :group
+
+    def validate
+      validates_not_null :group
+      validates_not_empty :group
+      return if group.blank?
+      validates_type Group, :group
+    end
+
+    def process
+      present ListUsersView, users: group.users
+    end
+  end
+end

data/lib/punk/actions/users/list_tenant.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PUNK
+  class ListTenantUsersAction < Action
+    args :tenant
+
+    def validate
+      validates_not_null :tenant
+      validates_not_empty :tenant
+      return if tenant.blank?
+      validates_type Tenant, :tenant
+    end
+
+    def process
+      present ListUsersView, users: tenant.users
+    end
+  end
+end

data/lib/punk/actions/users/show.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PUNK
+  class ShowUserAction < Action
+    args :user
+
+    def validate
+      validates_not_null :user
+      validates_not_empty :user
+      return if user.blank?
+      validates_type User, :user
+    end
+
+    def process
+      present ShowUserView, user: user
+    end
+  end
+end

data/lib/punk/commands/http.rb

@@ -24,7 +24,7 @@ PUNK::Command.create "PATCH" do
       "PATH_INFO" => args[0],
       "CONTENT_TYPE" => "text/json",
       "SCRIPT_NAME" => "",
-      "rack.input" => StringIO.new(args[1..].join)
+      "rack.input" => StringIO.new(args[1..-1].join)
     )
   end
 end
@@ -38,7 +38,7 @@ PUNK::Command.create "POST" do
       "PATH_INFO" => args[0],
       "CONTENT_TYPE" => "text/json",
       "SCRIPT_NAME" => "",
-      "rack.input" => StringIO.new(args[1..].join)
+      "rack.input" => StringIO.new(args[1..-1].join)
     )
   end
 end
@@ -52,7 +52,7 @@ PUNK::Command.create "PUT" do
       "PATH_INFO" => args[0],
       "CONTENT_TYPE" => "text/json",
       "SCRIPT_NAME" => "",
-      "rack.input" => StringIO.new(args[1..].join)
+      "rack.input" => StringIO.new(args[1..-1].join)
     )
   end
 end

data/lib/punk/commands/list.rb

@@ -4,25 +4,31 @@ PUNK::Command.create "list" do
   shortcut 'l'
   description "List routes, actions, models, views, services or workers"
 
+  option shortcut: :a, name: :all, description: "Include Punk!", type: nil
+
   def process
     case args.join(' ')
     when 'routes'
       PUNK.app
-      PUNK::App.route_list
+      PUNK::App.route_list # TODO: exclude PUNK routes by default
     when 'actions'
-      ObjectSpace.each_object(PUNK::Action.singleton_class).map(&:name).reject { |name| name.nil? || name =~ /^PUNK/ }
+      ObjectSpace.each_object(PUNK::Action.singleton_class).map(&:name).reject { |name| _hide?(name) }
     when 'models'
-      ObjectSpace.each_object(PUNK::Model.singleton_class).map(&:name).reject { |name| name.nil? || name =~ /^PUNK/ }
+      ObjectSpace.each_object(PUNK::Model.singleton_class).map(&:name).reject { |name| _hide?(name) }
     when 'views'
-      ObjectSpace.each_object(PUNK::View.singleton_class).map(&:name).reject { |name| name.nil? || name =~ /^PUNK/ }
+      ObjectSpace.each_object(PUNK::View.singleton_class).map(&:name).reject { |name| _hide?(name) }
     when 'services'
-      ObjectSpace.each_object(PUNK::Service.singleton_class).select { |klass| klass.superclass == PUNK::Service }.map(&:name).reject { |name| name.nil? || name =~ /^PUNK/ }
+      ObjectSpace.each_object(PUNK::Service.singleton_class).select { |klass| klass.superclass == PUNK::Service }.map(&:name).reject { |name| _hide?(name) }
     when 'workers'
-      ObjectSpace.each_object(PUNK::Worker.singleton_class).select { |klass| klass.superclass == PUNK::Worker }.map(&:name).reject { |name| name.nil? || name =~ /^PUNK/ }
+      ObjectSpace.each_object(PUNK::Worker.singleton_class).select { |klass| klass.superclass == PUNK::Worker }.map(&:name).reject { |name| _hide?(name) }
     when '', 'help'
       "? specify one of: routes, actions, models, views, services, workers"
     else
       "? unkown arguments: #{args.join(',')}"
     end
   end
+
+  def _hide?(name)
+    name.nil? || (name =~ /^PUNK/) && !opts[:all]
+  end
 end

data/lib/punk/config/defaults.json

@@ -30,6 +30,9 @@
     "api_key": "$USERSTACK_API_KEY",
     "use_ssl": false
   },
+  "ipstack": {
+    "api_key": "$IPSTACK_ACCESS_KEY"
+  },
   "db": {
     "url": "$DATABASE_URL"
   },

data/lib/punk/config/schema.json

@@ -32,6 +32,9 @@
     "api_key": "String",
     "use_ssl": "Flag"
   },
+  "ipstack": {
+    "api_key": "String"
+  },
   "log": {
     "enabled!": "Flag",
     "type!": "Enum(stdout, stderr, file)",

data/lib/punk/core/app.rb

@@ -23,7 +23,7 @@ module PUNK
 
   ROUTES = Tempfile.new("routes.json").path
   PUNK.profile_info("generate", path: ROUTES) do
-    system "roda-parse_routes -f #{ROUTES} #{File.expand_path(File.join(PUNK.get.app.path, 'routes', '*'))}"
+    system "roda-parse_routes -f #{ROUTES} #{File.expand_path(File.join(PUNK.get.app.path, 'routes', '*'))} #{File.expand_path(File.join(__dir__, '..', 'routes', '*'))}"
   end
 
   class App < Roda
@@ -36,7 +36,7 @@ module PUNK
       if File.exist?(index_path)
         File.read(index_path)
       else
-        <<~EOF
+        <<~INDEX_HTML
           <!DOCTYPE html>
           <html>
             <head>
@@ -47,7 +47,7 @@ module PUNK
               <p>Are you <a href="https://github.com/kranzky/lets-punk">ready</a> to rock?</p>
             </body>
           </html>
-        EOF
+        INDEX_HTML
       end
 
     plugin :sessions, secret: [PUNK.get.cookie.secret].pack('H*'),
@@ -88,8 +88,7 @@ module PUNK
 
     def require_session!
       begin
-        # TODO
-        @_current_session = nil #Session[request.session['session_id']]
+        @_current_session = Session[request.session['session_id']]
         if @_current_session&.active?
           @_current_session.touch
         else
@@ -192,9 +191,8 @@ module PUNK
       name = "#{request.request_method} #{request.path}"
       logger.info "Started #{name} for #{request.ip}", params.deep_symbolize_keys.sanitize.inspect
       logger.trace request.env['HTTP_USER_AGENT']
-      # TODO
-#     logger.info "Started #{name} for #{request.ip || Session.default_values[:remote_addr].to_s}", params.deep_symbolize_keys.sanitize.inspect
-#     logger.trace request.env['HTTP_USER_AGENT'] || Session.default_values[:user_agent]
+      logger.info "Started #{name} for #{request.ip || Session.default_values[:remote_addr].to_s}", params.deep_symbolize_keys.sanitize.inspect
+      logger.trace request.env['HTTP_USER_AGENT'] || Session.default_values[:user_agent]
       logger.trace request.env['HTTP_COOKIE']
       logger.push_tags(name)
       _set_cookie(request.env)