bites 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '08b2bf254de35cfc64624abf78f8c97582535214'
-  data.tar.gz: 9b5d0847c339a8655f4da60188ae9acbbbf3d879
+  metadata.gz: cd2276adb966be41561134043767feb48b6a15e1
+  data.tar.gz: 9a8d028165a5574bf097ab464db000a1a02cf5a3
 SHA512:
-  metadata.gz: cb8ebd85ee6d3892541655c11bf7c17cb8f8bc9b0c1a8ead8fbc40816fca3e4736ffd79eba7e2d90aaf2fc4e3967f9003fd0cf16bd168af3dabda98e00fcefb3
-  data.tar.gz: 1c890665e94048f89e1fcc4c5897c3db331eabfb856ec56ddffe221c9202499533dea6d291c64e1e1f414c54a14e2b8a12cdef7ed8114db973f068412988fa81
+  metadata.gz: 05323ca2ed434efee8432f0886516dbb6f8f1159c8d9396aed7834ca6da204df71a2c53135ab8a0f4a846524a13decee4ab0ec83456eb6a01a24b9921f1a3c8b
+  data.tar.gz: 6ef0b65196990c087e34eed761bcf3f2a823bc9c59875463c31fe09d8c684b147e2284775ffb280149c0e66807f47fdc9e8bb66a771656a991934670e29c4691

data/.gitignore

@@ -8,5 +8,7 @@
 /spec/reports/
 /tmp/
 
+.DS_Store
+
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,8 +1,8 @@
 # Bites
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bites`. To experiment with that code, run `bin/console` for an interactive prompt.
+> Content changes shouldn't require PRs.
 
-TODO: Delete this and the text above, and describe your gem
+Bites are a simple way of allowing anyone with the correct authorization to edit content from right within your webpage. Engineers shouldn't be the only ones capable of making copy changes, clients or non technical teammembers should be equally able.
 
 ## Installation
 
@@ -14,15 +14,44 @@ gem 'bites'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
+Once you've installed the gem you need to run
 
-    $ gem install bites
+    $ rails generate bites:install
+
+This includes a migration so you will also need to run `rails db:migrate`
 
 ## Usage
 
-TODO: Write usage instructions here
+Bites offers a simple template helper that inserts your content into the webpage
+
+```ruby
+<%= text_bite :text_identifier, default: 'This is some default text' %>
+```
+
+All you need to provide is an identifier symbol (e.g. `:homepage_welcome_text`).
+The default text is also used as the initial value.
+
+If you want to allow editing of the bite you must include the `Biteable` helper in the associated controller:
+
+```ruby
+class StaticPagesController < ApplicationController
+  include Biteable
+
+  def index
+  end
+end
+```
+
+Appending `edit_page=true` as a query param to the URL will enter the page into edit mode (where bites are replaced with text boxes).
+
+Edit ability is protected using HTTP simple auth. You must specify a username and password as environment variables:
+
+    BITES_USERNAME
+    BITES_PASSWORD
+
+I recommend using something like [dotenv](https://github.com/bkeepers/dotenv) for this.
 
 ## Development
 
@@ -32,7 +61,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bites. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/daibhin/bites. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +69,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the Bites project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bites/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Bites project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/daibhin/bites/blob/master/CODE_OF_CONDUCT.md).

data/app/controllers/bites_controller.rb

@@ -0,0 +1,9 @@
+class BitesController < ::ApplicationController
+
+  def update
+    bite = Bite.find(params[:id])
+    bite.update!(text: params[:bite][:text])
+    redirect_to :back
+  end
+
+end

data/app/models/bite.rb

@@ -0,0 +1,2 @@
+class Bite < ApplicationRecord
+end

data/bites.gemspec

@@ -3,6 +3,9 @@ lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "bites/version"
 
+# Building a new version of the gem:
+# gem build bites.gemspec
+
 Gem::Specification.new do |spec|
   spec.name          = "bites"
   spec.version       = Bites::VERSION
@@ -14,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{(^(test|spec|features)/|.gem$)})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -23,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "generator_spec"
 end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  resources :bites, only: [:update]
+end

data/lib/biteable.rb

@@ -0,0 +1,17 @@
+module Biteable
+  extend ActiveSupport::Concern
+
+  included do
+    before_filter :authenticate
+  end
+
+  def authenticate
+    if request.params[:edit_page]
+      authenticate_or_request_with_http_basic('Administration') do |username, password|
+        @bite_authentication = username == ENV['BITES_USERNAME'] && password == ENV['BITES_PASSWORD']
+      end
+    else
+      @bite_authentication = false
+    end
+  end
+end

data/lib/bites.rb

@@ -1,5 +1,5 @@
 require "bites/version"
+require "bites/engine"
 
 module Bites
-  # Your code goes here...
 end

data/lib/bites/bite_helper.rb

@@ -0,0 +1,17 @@
+module BiteHelper
+  def text_bite(identifier, options)
+    bite = Bite.find_by(identifier: identifier)
+    return bite_form(bite) if @bite_authentication
+    return Bite.create(identifier: identifier, text: options.default).text if bite.nil?
+    return bite.text unless bite.text.blank?
+    return options[:default] if options.present?
+  end
+
+  private def bite_form(bite)
+    render(
+      inline: "<%= form_for bite do |f| %><%= f.text_area :text %><%= f.submit 'Update' %><% end %>",
+      locals: { bite: bite }
+    )
+  end
+
+end

data/lib/bites/engine.rb

@@ -0,0 +1,11 @@
+require 'bites/bite_helper'
+
+module Bites
+  class Engine < Rails::Engine
+    require 'biteable'
+
+    initializer 'bite.helper' do |app|
+      ActionView::Base.send :include, BiteHelper
+    end
+  end
+end

data/lib/bites/version.rb

@@ -1,3 +1,3 @@
 module Bites
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/generators/bites/install/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Bites
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Add the migrations for Bites"
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_migrations
+        migration_template("create_bites.rb", "db/migrate/create_bites.rb")
+      end
+    end
+  end
+end

data/lib/generators/bites/install/templates/create_bites.rb

@@ -0,0 +1,14 @@
+class CreateBites < ActiveRecord::Migration
+  def up
+    create_table :bites do |t|
+      t.string :identifier, null: false
+      t.text :text, null: false, default: ""
+    end
+
+    add_index :bites, :identifier, unique: true
+  end
+
+  def down
+    drop_table :bites
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bites
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - David Newell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2018-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - d.newell1@outlook.com
@@ -67,11 +81,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/bites_controller.rb
+- app/models/bite.rb
 - bin/console
 - bin/setup
 - bites.gemspec
+- config/routes.rb
+- lib/biteable.rb
 - lib/bites.rb
+- lib/bites/bite_helper.rb
+- lib/bites/engine.rb
 - lib/bites/version.rb
+- lib/generators/bites/install/install_generator.rb
+- lib/generators/bites/install/templates/create_bites.rb
 homepage: https://daibhin.github.io
 licenses:
 - MIT