overture 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67719de8a9681b85fa9a2736febd368c53b2f5ed99650ec57c3997f812a23925
+  data.tar.gz: 82d3fefb3fb15f4674a8a2bdf8078865df14b86ad5bed0da2d8dc2c90fc4001c
+SHA512:
+  metadata.gz: d785fcc8a0fae25165899087c8238a2ed74eb9378fda5a146d35f731d4a20146d52696c4af7cee4365598220777e296a4778a7e40d212b2b78aeccb13e1d10f0
+  data.tar.gz: 544673208d5782b8623e378800e88649158201368d35af737077bb7151724d9123d150725e74dae43d675b10212390a1b017619fdfbf4c594e5d1e89ac103572

data/README.md

@@ -0,0 +1,15 @@
+# Overture
+
+This is a library of tools and configurations based on the Clean Architecture.
+
+This gem contains the basic configuration options and file organization to create a Ruby application.
+
+Sinatra is used as a delivery layer, but it can be easily replaced. Core business rules live in the Interactors.
+
+## Contents
+
+- `Overture::Database`
+- `Overture::Interactor`
+- `Overture::Model`
+- `Overture::PasswordDigester`
+

data/bin/overture-migration

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'fileutils'
+
+class Parser
+  def self.parse(options = {})
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = 'Usage: overture-generate migration [options]'
+
+      opts.on '-nNAME', '--name=NAME', 'Migration name' do |n|
+        options[:name] = n
+      end
+
+      opts.on '-h', '--help', 'Prints this message' do
+        puts opts
+        exit
+      end
+    end
+
+    opt_parser.parse!(options)
+    options
+  end
+end
+
+options = Parser.parse
+
+if options[:name].nil?
+  Parser.parse(['--help'])
+  exit
+end
+
+def generate_migration(name)
+  timestamp = Time.now.strftime('%Y%m%d%H%M%S')
+  filename = "migrations/#{timestamp}_#{name.tr(' ', '_').downcase}.rb"
+
+  FileUtils.mkdir_p('migrations')
+  File.open(filename, 'w') do |f|
+    f.puts <<~TEMPLATE
+      # frozen_string_literal: true
+
+      Sequel.migration do
+        table_name = :table_name # change this
+
+        up do
+          create_table(table_name) do
+            primary_key :id
+            DateTime :created_at, null: false
+            DateTime :updated_at, null: false
+          end
+        end
+
+        down do
+          drop_table(table_name)
+        end
+      end
+
+    TEMPLATE
+  end
+  puts "-----------> Created db migration: #{filename}"
+end
+
+generate_migration(options[:name])
+

data/lib/overture.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'dotenv/load'
+require 'overture/version'
+

data/lib/overture/database.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'sequel'
+
+Sequel.database_timezone = :utc
+Sequel.application_timezone = :local
+Sequel.extension :datetime_parse_to_time
+
+module Overture
+  module Database
+    DEFAULT_OPTIONS = {
+      extensions: %i[
+        pg_array
+        pg_json
+        pg_timestamptz
+        named_timezones
+      ],
+    }.freeze
+
+    module_function
+
+    def connect(url, options = {})
+      Sequel.connect(url, DEFAULT_OPTIONS.merge(options))
+    end
+  end
+end
+

data/lib/overture/interactor.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'interactor'
+
+module Overture
+  class Interactor
+    include ::Interactor
+
+    class << self
+      def required(*input)
+        before do
+          opts = input.last.is_a?(Hash) ? input.pop : {}
+          allow_empty = opts[:allow_empty]
+
+          input.each do |attr|
+            value = context.public_send(attr)
+            empty = value.respond_to?(:empty?) ? value.empty? : false
+            valid = !value.nil? && (allow_empty ? true : !empty)
+            fail!("#{attr} is required") unless valid
+          end
+        end
+      end
+    end
+
+    def fail!(message)
+      context.fail!(error: message)
+    end
+  end
+end
+

data/lib/overture/model.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'sequel'
+
+module Overture
+  Model = Class.new(Sequel::Model)
+  Model.def_Model(self)
+  Model.plugin :timestamps, update_on_create: true
+  Model.plugin :many_through_many
+  Model.plugin :defaults_setter
+end
+

data/lib/overture/password_digester.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bcrypt'
+
+module Overture
+  module PasswordDigester
+    def valid_password?(password_digest, password)
+      BCrypt::Password.new(password_digest).is_password?(password)
+    rescue BCrypt::Errors::InvalidHash
+      false
+    end
+
+    def digest_password(password, cost: BCrypt::Engine.cost)
+      BCrypt::Password.create(password, cost: cost)
+    end
+  end
+end
+

data/lib/overture/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Overture
+  VERSION = '0.1.0'
+end
+

data/lib/tasks/db.rake

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'sequel'
+
+Sequel.extension :migration
+
+namespace :db do
+  desc 'Run migrations for $DATABASE_URL'
+  task :migrate, [:version] do |_t, args|
+    require_relative '../overture/database'
+
+    DB ||= Overture::Database.connect(ENV['DATABASE_URL'])
+    version = args[:version].to_i if args[:version]
+
+    def pk_uuid(name)
+      column name, :uuid, primary_key: true, default: Sequel.function(:uuid_generate_v4)
+    end
+
+    puts "Migrating database to #{version ? "version #{version}" : 'latest version'}..."
+    Sequel::Migrator.run(DB, 'migrations', target: version)
+  end
+
+  desc 'Resets $DATABASE_URL schema to latest version'
+  task :reset do
+    Rake::Task['db:migrate'].reenable
+    Rake::Task['db:migrate'].invoke(0)
+    Rake::Task['db:migrate'].reenable
+    Rake::Task['db:migrate'].invoke
+  end
+
+  namespace :test do
+    desc 'Resets $TEST_DATABASE_URL database schema to latest version'
+    task :reset do
+      ENV['RACK_ENV'] = 'test'
+      ENV['DATABASE_URL'] = ENV['TEST_DATABASE_URL']
+
+      Rake::Task['db:migrate'].reenable
+      Rake::Task['db:migrate'].invoke(0)
+      Rake::Task['db:migrate'].reenable
+      Rake::Task['db:migrate'].invoke
+    end
+  end
+end
+

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: overture
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- edgarjs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: interactor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sequel_pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2018'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2018'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+description: |
+  Tools and configurations based on the Clean Architecture.
+
+  This gem contains the basic configuration options and file
+  organization to create a Ruby application.
+
+  Sinatra is used as a delivery layer, but it can be easily
+  replaced. Core business rules live in the Interactors.
+email: edgar.js@gmail.com
+executables:
+- overture-migration
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/overture-migration
+- lib/overture.rb
+- lib/overture/database.rb
+- lib/overture/interactor.rb
+- lib/overture/model.rb
+- lib/overture/password_digester.rb
+- lib/overture/version.rb
+- lib/tasks/db.rake
+homepage: https://github.com/edgarjs/overture
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Tools and configurations for your web app.
+test_files: []