boutique 0.0.11 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60fd1d83530e2f764fa03935ded63d4eb1f776f9
+  data.tar.gz: 9c2561be47adbe33b57ccac1af6db4b1d37e4a29
+SHA512:
+  metadata.gz: d5b45c086596e4ae72cc5977ce98b4db52bae8dd48d2640e57e886884601cea229adb5a4c3b9ebca5deb6edada835d261d4b7dff6cee2dc27be7d4eb0a995901
+  data.tar.gz: 6150e6f5678ec6003418ca1bccb8a91c17b6f62b0f2065e2e01363ff025fb772f9d4bdda066d38a6f68ed7105e9cb9cbf70b6b4c80c3513267f8e002a89b5b90

data/README.md

@@ -1,11 +1,9 @@
-Description
-===========
+# Description
 
 Boutique is a Sinatra app for drip emails (and soon-to-be product checkouts).
 Still in development!
 
-Installation
-============
+# Installation
 
     $ gem install boutique
 
@@ -15,12 +13,12 @@ Setup a `config.ru` file and run it like any other Sinatra app:
     require 'boutique'
 
     Boutique.configure do |c|
-      c.dev_email      'dev@mailinator.com'
+      c.error_email    'dev@mailinator.com'
       c.stripe_api_key 'sk_test_abcdefghijklmnopqrstuvwxyz'
       c.download_dir   '/path/to/download'
       c.download_path  '/download'
 
-      c.db_options(adapter: 'postgresql', host: 'localhost',
+      c.db_options(adapter: 'postgres', host: 'localhost',
         username: 'root', password: 'secret', database: 'boutique')
       c.email_options(via: :smtp, via_options: {host: 'smtp.example.org'})
     end
@@ -41,14 +39,13 @@ Now setup the database tables (assuming you've already created the database and
 credentials) and stick the `.css` and `.js` files in your project.  Note that
 `boutique.js` is dependent on jQuery.
 
-    $ boutique --migrate
+    $ bin/boutique --migrate
     $ boutique --assets
        new -- boutique.js
        new -- boutique.css
     $ mv boutique.js boutique.css /path/to/project/assets/.
 
-Drip Emails
-===========
+# Drip Emails
 
 Emails can be written in any templating format that `Tilt` accepts.  Stick them
 in `/path/to/emails-dir` (configured above in `config.ru`).  Emails use
@@ -110,26 +107,31 @@ day by mistake.  Use cron to schedule drips:
     $ crontab -e
     0 8 * * * boutique --drip
 
-Development
-===========
+# Rack Extensions
 
-Tests are setup to run individually via `ruby test/*_test.rb` or run them all
-via `rake`.
+I recommend using these extensions in production:
+
+* [Rack Timeout](https://github.com/heroku/rack-timeout)
+* [Rack Throttle](https://github.com/datagraph/rack-throttle)
+
+# Development
+
+Run all tests with `rake`.
+
+Run individual tests with `ruby path/to/test.rb` or `rake TEST=path/to/test.rb`.
 
 To start the server for local development:
 
     $ BOUTIQUE_DEV=1 shotgun
 
-TODO
-====
+# TODO
 
-* add UI for error handling and invalid emails
-* switch to Stripe
-* add customizable? email integration for purchase receipts + recover
+* add Stripe integration
+* add template-able email integration for purchase receipts + recover
 * add re-usable UI for purchasing, downloading, recover
+* upgrade to Tilt 2.0
 
-License
-=======
+# License
 
 Copyright Hugh Bien - http://hughbien.com.
 Released under BSD License, see LICENSE.md for more info.

data/{boutique → bin/boutique}

@@ -1,9 +1,8 @@
 #!/usr/bin/env ruby
-require 'optparse'
-require File.expand_path('lib/boutique', File.dirname(__FILE__))
-require 'dm-migrations'
 require 'date'
 require 'fileutils'
+require 'optparse'
+require_relative '../lib/boutique'
 
 ENV['BOUTIQUE_CMD'] = '1'
 
@@ -40,10 +39,7 @@ module Boutique
 
     def self.migrate
       load_config
-      DataMapper.auto_upgrade!
-    rescue DataObjects::SyntaxError => e
-      DataMapper.auto_upgrade!
-      load_config
+      Boutique::Migrate.run
     end
 
     private

data/config.ru

@@ -1,18 +1,19 @@
+require 'sqlite3'
 require File.expand_path('lib/boutique', File.dirname(__FILE__))
 
-Boutique.configure(ENV['BOUTIQUE_DEV'] || !ENV['BOUTIQUE_CMD'].nil?) do |c|
-  #c.dev_email      'dev@localhost'
+Boutique.configure do |c|
+  # c.error_email    'dev@localhost'
   c.stripe_api_key 'sk_test_abcdefghijklmnopqrstuvwxyz'
   c.download_path  '/download'
   c.download_dir   File.expand_path('temp', File.dirname(__FILE__))
   c.db_options(
-    adapter: 'sqlite3',
+    adapter: 'sqlite',
     host: 'localhost',
     username: 'root',
     password: 'secret',
     database: 'db.sqlite3')
   c.email_options(via: :sendmail)
-end
+end if ENV['RACK_ENV'] != 'test'
 
 Boutique.product('readme') do |p|
   p.from 'support@localhost'

data/lib/boutique.rb

@@ -1,361 +1,18 @@
-require 'rubygems'
 require 'bundler/setup'
-require 'sinatra/base'
-require 'dm-core'
-require 'dm-types'
-require 'dm-timestamps'
-require 'dm-validations'
+require 'cgi'
 require 'date'
-require 'digest/sha1'
 require 'json'
 require 'openssl'
 require 'pony'
 require 'preamble'
-require 'tilt'
+require 'securerandom'
+require 'sequel'
+require 'sinatra/base'
 require 'tempfile'
+require 'tilt'
 require 'uri'
-require 'cgi'
-
-DataMapper::Model.raise_on_save_failure = true
-
-module Boutique
-  VERSION = '0.0.11'
-
-  class << self
-    def configure(setup_db=true)
-      yield config
-      DataMapper.setup(:default, config.db_options) if setup_db
-      Pony.options = config.email_options if !config.email_options.nil?
-    end
-
-    def config
-      @config ||= Config.new('config')
-    end
-
-    def product(key)
-      yield Product.new(key)
-    end
-
-    def list(key)
-      yield List.new(key)
-    end
-  end
-
-  module MemoryResource
-    def self.included(base)
-      base.extend(ClassMethods)
-      base.attr_resource :key
-      base.reset_db
-    end
-
-    module ClassMethods
-      def attr_resource(*names)
-        names.each do |name|
-          define_method(name) do |*args|
-            value = args[0]
-            instance_variable_set("@#{name}".to_sym, value) if !value.nil?
-            instance_variable_get("@#{name}".to_sym)
-          end
-        end
-      end
-
-      def reset_db
-        @db = {}
-      end
-
-      def [](key)
-        @db[key]
-      end
-
-      def []=(key, value)
-        @db[key] = value
-      end
-
-      def include?(key)
-        self.to_a.include?(key)
-      end
-
-      def to_a
-        @db.keys
-      end
-    end
-
-    def initialize(key)
-      @key = key
-      self.class[key] = self
-    end
-  end
-
-  class Emailer
-    def initialize(list, directory = nil)
-      @list = list
-      @directory = directory
-    end
-
-    def render(path, locals = {}, preamble = false)
-      path = @directory ?
-        File.join(@directory, path) :
-        full_path(path)
-      raise "File not found: #{path}" if !File.exist?(path)
-
-      yaml, body = preamble(path)
-      templates_for(path).each do |template|
-        blk = proc { body }
-        body = template.new(path, &blk).render(self, locals)
-      end
-
-      preamble ? [yaml, body] : body
-    end
-
-    def deliver(subscriber, path, locals = {})
-      locals = locals.merge(
-        subscribe_url: @list.subscribe_url,
-        confirm_url: subscriber.confirm_url,
-        unsubscribe_url: subscriber.unsubscribe_url)
-      yaml, body = self.render(path, locals, true)
-      if yaml['day'] == 0
-        ymd = Date.today.strftime("%Y-%m-%d")
-        Email.create(email_key: "#{yaml['key']}-#{ymd}", subscriber: subscriber)
-      else
-        raise "Unconfirmed #{subscriber.email} for #{yaml['key']}" if !subscriber.confirmed?
-        Email.create(email_key: yaml['key'], subscriber: subscriber)
-      end
-      Pony.mail(
-        to: subscriber.email,
-        from: @list.from,
-        subject: yaml['subject'],
-        headers: {'Content-Type' => 'text/html'},
-        body: body)
-    rescue DataMapper::SaveFailureError
-      raise "Duplicate email #{yaml['key']} to #{subscriber.email}"
-    end
-
-    def deliver_zero(subscriber)
-      self.deliver(subscriber, emails[0])
-    end
-
-    def blast(path, locals = {})
-      yaml, body = preamble(full_path(path))
-      email_key = yaml['key']
-      @list.subscribers.all(confirmed: true).each do |subscriber|
-        # TODO: speed up by moving filter outside of loop
-        if Email.first(email_key: yaml['key'], subscriber: subscriber).nil?
-          self.deliver(subscriber, path, locals)
-        end
-      end
-    end
-
-    def drip
-      today = Date.today
-      max_day = emails.keys.max || 0
-      subscribers = @list.subscribers.all(
-        :confirmed => true,
-        :drip_on.lt => today,
-        :drip_day.lt => max_day)
-      subscribers.each do |subscriber|
-        subscriber.drip_on = today
-        subscriber.drip_day += 1
-        subscriber.save
-        if (email_path = emails[subscriber.drip_day])
-          self.deliver(subscriber, email_path)
-        end
-      end
-    end
-
-    private
-    def full_path(path)
-      File.join(@list.emails, path)
-    end
-
-    def templates_for(path)
-      basename = File.basename(path)
-      basename.split('.')[1..-1].reverse.map { |ext| Tilt[ext] }
-    end
-
-    def emails
-      @emails ||= begin
-        emails = {}
-        Dir.entries(@list.emails).each do |filename|
-          next if File.directory?(filename)
-          # TODO: stop duplicating calls to preamble, store in memory
-          yaml, body = preamble(full_path(filename))
-          if yaml && yaml['day'] && yaml['key']
-            emails[yaml['day']] = filename
-          end
-        end
-        emails
-      end
-    end
-
-    def preamble(path)
-      Preamble.load(path)
-    rescue
-      [{}, File.read(path)]
-    end
-  end
-
-  class Config
-    include MemoryResource
-    attr_resource :dev_email,
-      :stripe_api_key,
-      :download_dir,
-      :download_path,
-      :db_options,
-      :email_options
-  end
-
-  class Product
-    include MemoryResource
-    attr_resource :from, :files, :price
-  end
-
-  class List
-    include MemoryResource
-    attr_resource :from, :emails, :url
-
-    def subscribers
-      Subscriber.all(list_key: self.key)
-    end
-
-    def subscribe_url
-      url = URI.parse(self.url)
-      params = [url.query]
-      params << "boutique=subscribe/#{CGI.escape(self.key)}"
-      url.query = params.compact.join('&')
-      url.to_s
-    end
-  end
-
-  class Purchase
-    include DataMapper::Resource
-
-    property :id, Serial
-    property :product_key, String, required: true
-    property :created_at, DateTime
-    property :counter, Integer, required: true
-    property :secret, String, required: true
-    property :transaction_id, String
-    property :email, String
-    property :name, String, format: :email_address
-    property :completed_at, DateTime
-    property :downloads, CommaSeparatedList
-  end
-
-  class Subscriber
-    include DataMapper::Resource
-
-    property :id, Serial
-    property :list_key, String, required: true, unique_index: :list_key_email
-    property :email, String, required: true, unique_index: :list_key_email, format: :email_address
-    property :secret, String, required: true
-    property :confirmed, Boolean
-    property :created_at, DateTime
-    property :drip_on, Date, required: true
-    property :drip_day, Integer, required: true, default: 0
-
-    validates_within :list_key, set: List
-    validates_uniqueness_of :email, scope: :list_key
-
-    has n, :emails
-
-    def initialize(*args)
-      super
-      self.secret ||= Digest::SHA1.hexdigest("#{rand(1000)}-#{Time.now}")[0..6]
-      self.drip_on ||= Date.today
-    end
-
-    def list
-      @list ||= List[self.list_key]
-    end
-
-    def confirm!(secret)
-      self.confirmed = true if self.secret == secret
-      self.save
-    end
-
-    def unconfirm!(secret)
-      self.confirmed = false if self.secret == secret
-      self.save
-    end
-
-    def confirm_url
-      secret_url("confirm")
-    end
-
-    def unsubscribe_url
-      secret_url("unsubscribe")
-    end
-
-    private
-    def secret_url(action)
-      url = URI.parse(self.list.url)
-      params = [url.query]
-      params << "boutique=#{action}/#{CGI.escape(self.list_key)}/#{self.id}/#{self.secret}"
-      url.query = params.compact.join('&')
-      url.to_s
-    end
-  end
-
-  class Email
-    include DataMapper::Resource
-
-    property :id, Serial
-    property :email_key, String, required: true
-    property :created_at, DateTime
-
-    validates_uniqueness_of :email_key, scope: :subscriber
-    validates_presence_of :subscriber
-
-    belongs_to :subscriber
-  end
-
-  DataMapper.finalize
-
-  class App < Sinatra::Base
-    set :raise_errors, false
-    set :show_exceptions, false
-
-    error do
-      Pony.mail(
-        :to => Boutique.config.dev_email,
-        :subject => 'Boutique Error',
-        :body => request.env['sinatra.error'].to_s
-      ) if Boutique.config.dev_email
-    end
-
-    post '/subscribe/:list_key' do
-      list = get_list(params[:list_key])
-      subscriber = Subscriber.first_or_create(
-        list_key: list.key,
-        email: params[:email])
-      Emailer.new(list).deliver_zero(subscriber) rescue nil
-      ''
-    end
-
-    post '/confirm/:list_key/:id/:secret' do
-      list = get_list(params[:list_key])
-      subscriber = get_subscriber(params[:id], list, params[:secret])
-      subscriber.confirm!(params[:secret])
-      ''
-    end
-
-    post '/unsubscribe/:list_key/:id/:secret' do
-      list = get_list(params[:list_key])
-      subscriber = get_subscriber(params[:id], list, params[:secret])
-      subscriber.unconfirm!(params[:secret])
-      ''
-    end
-
-    private
-    def get_list(list_key)
-      List[list_key] || halt(404)
-    end
 
-    def get_subscriber(id, list, secret)
-      Subscriber.first(
-        id: params[:id],
-        list_key: list.key,
-        secret: secret) || halt(404)
-    end
-  end
-end
+require_relative 'boutique/app'
+require_relative 'boutique/config'
+require_relative 'boutique/emailer'
+require_relative 'boutique/version'