beespew 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 608b7f3cc3cc06379fee5f58e06b37c6cb5abd56
-  data.tar.gz: f1108f5329702c8b9a6d95fb50ccbb60285e9d2e
+  metadata.gz: 3d5270813ca79bb6eb252460705ee6c1ff677261
+  data.tar.gz: 0d25efbbeaeb2a33c98f5d6b8bc7d78e541602b5
 SHA512:
-  metadata.gz: fcc7841da6effdc3cf1669d7d39ab1452508a5b9c837fbb54fc2c7a1845ba761b6833577aab480132433c446ee1fa16583f54a564f57bb85aefeac0825af4047
-  data.tar.gz: cd75133b6e54fec59af424d5871c553a86ff683f6ec794793968616e2afd6605307db493be7450af000dc32ca73677aa7ce9ab24734949e8fb052208355c228b
+  metadata.gz: 0be21555222274055af659424d17de19d2bda8d03b7a07d660bfa41dff8206a96397357d80f444105d79671f1e2f62385dc85f005a98e8fbe602d7715361043e
+  data.tar.gz: 43bd786e38c75709b749912191cb81aad985fcbe75177bffadca10d4a2c6a948f8b32bdce00e8dcbfab7819fc2e55d33b3bdd458bdceec294eb34dac6321163a

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+- 2.0.0
+- 2.1.5
+cache: bundler
+script:
+- bundle exec rspec spec
+notifications:
+  webhooks:
+    secure: PZ9zkk1aar0shHE87JpIE9+OgjTgYFoiK0cP+jNcuF/GjhVaypkaieKzCRldERkkz2YEi2eIqgKhybQpYAcG4q1vhpjiBpOOdLYmTsRFCSoDwt8fAlC9JRI3+D6nc4hF1y8ds9aVoYQVfCcGasIOH4KAKMbKGviPgyFIhdbIbDw=

data/README.md

@@ -1,4 +1,4 @@
-# Beespew
+# Beespew [![Build Status](https://travis-ci.org/Absolventa/beespew.svg?branch=master)](https://travis-ci.org/Absolventa/beespew)
 
 **Beespew** is a lightweight spam protection plugin for Rails 4 using
 honeypot input fields. Beespew … honeypot … get it? :wink:
@@ -40,6 +40,13 @@ Add a text field to your form:
       f.text_field :beespew, placeholder: "If you are a human, leave this blank", class: 'beespew'
     end
 
+Alternatively, you can use Beespew's form helper:
+
+    form_for :comment, builder: Beespew::FormBuilder do |f|
+      # ...
+      f.honeypot, placeholder: "If you are a human, leave this blank"
+    end
+
 **Note**: Don't use `hidden_field` as bots are "smart" enough to leave those untouched.
 Use CSS to hide it for human users and avoid `display:none` and
 `visibility:hidden` here as well.
@@ -85,5 +92,12 @@ strong parameters will unwillingly disable your spam protection.
 
 ## Changelog
 
+### HEAD (not released yet)
+
+### 0.2.0
+* Add Beespew form builder with `honeypot` field
+* Make Beespew.attribute configurable ([#1](https://github.com/Absolventa/beespew/issues/1))
+* Add a default hidden style for honeypot field ([#3](https://github.com/Absolventa/beespew/issues/3))
+
 ### 0.1.0
 * Initial working version

data/app/assets/stylesheets/beespew/beespew.css

@@ -0,0 +1,8 @@
+.beespew {
+  position: absolute !important;
+  height: 1px; width: 1px;
+  overflow: hidden;
+  clip: rect(1px 1px 1px 1px); /* IE6, IE7 */
+  clip: rect(1px, 1px, 1px, 1px);
+}
+

data/config/locales/de.yml

@@ -0,0 +1,3 @@
+de:
+  beespew:
+    placeholder: "Dieses Feld bitte nicht beschriften"

data/lib/beespew/engine.rb

@@ -0,0 +1,5 @@
+module Beespew
+  class Engine < ::Rails::Engine
+    isolate_namespace Beespew
+  end
+end

data/lib/beespew/form_builder.rb

@@ -0,0 +1,19 @@
+module Beespew
+  class FormBuilder < ActionView::Helpers::FormBuilder
+
+    def beespew_field(options = {})
+      options = { class: 'beespew', placeholder: placeholder }.
+        merge(options.with_indifferent_access)
+      text_field Beespew.attribute, options
+    end
+
+    alias honeypot beespew_field
+
+    private
+
+    def placeholder
+      I18n.t "beespew.placeholder", default: 'If you are human, leave this blank'
+    end
+
+  end
+end

data/lib/beespew/version.rb

@@ -1,3 +1,3 @@
 module Beespew
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/beespew.rb

@@ -1,8 +1,14 @@
+require 'beespew/engine'
 require 'beespew/model'
 
 module Beespew
+  autoload :FormBuilder, 'beespew/form_builder'
 
   mattr_accessor :attribute
   @@attribute  = 'beespew'.freeze
 
+  def self.configure
+    yield self
+  end
+
 end

data/spec/beespew_spec.rb

@@ -3,7 +3,15 @@ require 'spec_helper'
 describe Beespew do
 
   describe '.attribute' do
-    it { expect(Beespew.attribute).to eql 'beespew' }
+    it 'defaults to "beespew"' do
+      expect(Beespew.attribute).to eql 'beespew'
+    end
+  end
+
+  describe '.configure' do
+    it 'yields itself' do
+      expect { |b| Beespew.configure(&b) }.to yield_with_args(Beespew)
+    end
   end
 
 end

data/spec/dummy/app/assets/stylesheets/application.css

@@ -12,4 +12,5 @@
  *
  *= require_tree .
  *= require_self
+ *= require beespew/beespew
  */

data/spec/dummy/app/controllers/support_requests_controller.rb

@@ -0,0 +1,21 @@
+class SupportRequestsController < ApplicationController
+
+  def new
+    @support_request = SupportRequest.new
+  end
+
+  def create
+    @support_request = SupportRequest.new(support_request_params)
+    if @support_request.save
+      redirect_to new_support_request_path, notice: 'Support Request created.'
+    else
+      render :new
+    end
+  end
+
+  private
+
+  def support_request_params
+    params.require(:support_request).permit(:message, :subject, :beespew)
+  end
+end

data/spec/dummy/app/models/support_request.rb

@@ -0,0 +1,5 @@
+class SupportRequest < ActiveRecord::Base
+  include Beespew::Model
+
+  validates :subject, presence: true
+end

data/spec/dummy/app/views/support_requests/new.html.erb

@@ -0,0 +1,27 @@
+<%= form_for @support_request, builder: Beespew::FormBuilder do |f| %>
+
+  <% unless @support_request.valid? %>
+    <ul>
+      <% @support_request.errors.full_messages.each do |err| %>
+        <li><%= err %></li>
+      <% end %>
+    </ul>
+  <% end %>
+
+  <p>
+    <%= f.label :subject %><br>
+    <%= f.text_field :subject %>
+  </p>
+
+  <p>
+    <%= f.label :message %><br>
+    <%= f.text_area :message %>
+  </p>
+
+  <%= f.honeypot %>
+
+  <p>
+    <%= f.submit %>
+  </p>
+
+<% end %>

data/spec/dummy/config/application.rb

@@ -5,7 +5,7 @@ require "active_record/railtie"
 require "action_controller/railtie"
 require "action_mailer/railtie"
 require "action_view/railtie"
-# require "sprockets/railtie"
+require "sprockets/railtie"
 # require "rails/test_unit/railtie"
 
 Bundler.require(*Rails.groups)

data/spec/dummy/config/locales/de.yml

@@ -0,0 +1,2 @@
+de:
+  hello: "Hallo Welt"

data/spec/dummy/config/routes.rb

@@ -1,56 +1,6 @@
 Rails.application.routes.draw do
-  # The priority is based upon order of creation: first created -> highest priority.
-  # See how all your routes lay out with "rake routes".
+  root 'support_requests#new'
 
-  # You can have the root of your site routed with "root"
-  # root 'welcome#index'
+  resources :support_requests
 
-  # Example of regular route:
-  #   get 'products/:id' => 'catalog#view'
-
-  # Example of named route that can be invoked with purchase_url(id: product.id)
-  #   get 'products/:id/purchase' => 'catalog#purchase', as: :purchase
-
-  # Example resource route (maps HTTP verbs to controller actions automatically):
-  #   resources :products
-
-  # Example resource route with options:
-  #   resources :products do
-  #     member do
-  #       get 'short'
-  #       post 'toggle'
-  #     end
-  #
-  #     collection do
-  #       get 'sold'
-  #     end
-  #   end
-
-  # Example resource route with sub-resources:
-  #   resources :products do
-  #     resources :comments, :sales
-  #     resource :seller
-  #   end
-
-  # Example resource route with more complex sub-resources:
-  #   resources :products do
-  #     resources :comments
-  #     resources :sales do
-  #       get 'recent', on: :collection
-  #     end
-  #   end
-
-  # Example resource route with concerns:
-  #   concern :toggleable do
-  #     post 'toggle'
-  #   end
-  #   resources :posts, concerns: :toggleable
-  #   resources :photos, concerns: :toggleable
-
-  # Example resource route within a namespace:
-  #   namespace :admin do
-  #     # Directs /admin/products/* to Admin::ProductsController
-  #     # (app/controllers/admin/products_controller.rb)
-  #     resources :products
-  #   end
 end

data/spec/dummy/db/migrate/20141208164522_create_support_requests.rb

@@ -0,0 +1,10 @@
+class CreateSupportRequests < ActiveRecord::Migration
+  def change
+    create_table :support_requests do |t|
+      t.string :subject
+      t.string :message
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20141208164522) do
+
+  create_table "support_requests", force: true do |t|
+    t.string   "subject"
+    t.string   "message"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/spec/form_helper_spec.rb

@@ -0,0 +1,76 @@
+describe Beespew::FormBuilder do
+  let(:the_hive) { active_model.new }
+
+  subject { described_class.new :hive, the_hive, template, {} }
+
+  describe '#beespew_field' do
+    it 'returns a text field with a default css class' do
+      input = subject.beespew_field
+
+      expected = '<input class="beespew" id="hive_beespew" name="hive[beespew]" '
+      expect(input).to start_with expected
+    end
+
+    it 'returns a text field with a custom css class' do
+      input = subject.beespew_field class: 'foobar'
+
+      expected = '<input class="foobar" id="hive_beespew" name="hive[beespew]" '
+      expect(input).to start_with expected
+    end
+
+    it 'obeyes the configured Beespew.attribute' do
+      allow(Beespew).to receive(:attribute).and_return('sweetsformysweet')
+      input = subject.beespew_field
+
+      expected = '<input class="beespew" id="hive_sweetsformysweet" name="hive[sweetsformysweet]"'
+      expect(input).to start_with expected
+    end
+
+    context 'with placeholder' do
+      it 'returns an English text by default' do
+        text = "If you are human, leave this blank"
+        expect(subject.beespew_field).to match "placeholder=\"#{text}\""
+      end
+
+      it 'overrides the placeholder' do
+        input = subject.beespew_field placeholder: 'Leave this shizzle'
+        expect(input).to match "placeholder=\"Leave this shizzle\""
+      end
+
+      context 'with internationalization' do
+        before { I18n.locale = :de }
+        after  { I18n.locale = :en }
+
+        it 'uses a translated string' do
+          text = "Dieses Feld bitte nicht beschriften"
+          expect(subject.beespew_field).to match "placeholder=\"#{text}\""
+        end
+      end
+    end
+
+  end
+
+  describe '#honeypot' do
+    it 'is an alias for #beespew_field' do
+      args = { hello: 'world' }
+      expected = subject.beespew_field(args)
+      expect(subject.honeypot(args)).to eql expected
+    end
+  end
+
+  def active_model
+    @klass ||= Class.new do
+      include ActiveModel::Model
+      include Beespew::Model
+      attr_accessor :drones, :queen
+    end
+  end
+
+  def template
+    @template ||= begin
+                    template = Object.new
+                    template.extend ActionView::Helpers::FormHelper
+                    template.extend ActionView::Helpers::FormOptionsHelper
+                  end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beespew
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Carsten Zimmermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-04 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -69,12 +69,17 @@ files:
 - .rspec
 - .ruby-gemset
 - .ruby-version
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/stylesheets/beespew/beespew.css
 - beespew.gemspec
+- config/locales/de.yml
 - lib/beespew.rb
+- lib/beespew/engine.rb
+- lib/beespew/form_builder.rb
 - lib/beespew/model.rb
 - lib/beespew/version.rb
 - spec/beespew_spec.rb
@@ -85,11 +90,14 @@ files:
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/controllers/support_requests_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.keep
 - spec/dummy/app/models/.keep
 - spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/models/support_request.rb
 - spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/support_requests/new.html.erb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
 - spec/dummy/bin/rake
@@ -108,15 +116,19 @@ files:
 - spec/dummy/config/initializers/mime_types.rb
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/de.yml
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
+- spec/dummy/db/migrate/20141208164522_create_support_requests.rb
+- spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.keep
 - spec/dummy/log/.keep
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
+- spec/form_helper_spec.rb
 - spec/model_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Absolventa/beespew
@@ -152,11 +164,14 @@ test_files:
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/controllers/support_requests_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.keep
 - spec/dummy/app/models/.keep
 - spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/models/support_request.rb
 - spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/support_requests/new.html.erb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
 - spec/dummy/bin/rake
@@ -175,14 +190,18 @@ test_files:
 - spec/dummy/config/initializers/mime_types.rb
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/de.yml
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
+- spec/dummy/db/migrate/20141208164522_create_support_requests.rb
+- spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.keep
 - spec/dummy/log/.keep
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
+- spec/form_helper_spec.rb
 - spec/model_spec.rb
 - spec/spec_helper.rb