permalinkable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 917d1aae3fcb6fc297bd8eeccff7fbe083ad3271
+  data.tar.gz: 1ca4b745e27f77cadcf6221885a920c89cc5485b
+SHA512:
+  metadata.gz: 895dfc0204ac64e66ba324dbc42e24fd2c28fb4d8da52473546e5fa5b4334dcb18df5442599200b174c2d9077cefe2b55ca994f30e3c659ece7880d79f7cd2e7
+  data.tar.gz: d40972d8bdced2b8ce3164bf0b5b17245f720df4a27c1bc2c4acb3815a2101228542401db06f304407619dbc66b4fc86efcead26b205758ecd2324f52d031edc

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use  ruby-2.1.2@permalinkable  --create

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    permalinkable (0.1.0)
+      activerecord (~> 4.0)
+      hashie (~> 3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.5)
+      actionview (= 4.1.5)
+      activesupport (= 4.1.5)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+    activerecord (4.1.5)
+      activemodel (= 4.1.5)
+      activesupport (= 4.1.5)
+      arel (~> 5.0.0)
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    factory_girl (4.4.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.4.1)
+      factory_girl (~> 4.4.0)
+      railties (>= 3.0.0)
+    hashie (3.3.1)
+    i18n (0.6.11)
+    json (1.8.1)
+    minitest (5.4.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.1.5)
+      actionpack (= 4.1.5)
+      activesupport (= 4.1.5)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  factory_girl_rails (~> 4.4)
+  permalinkable!
+  rake (~> 10.1)
+  rspec (~> 3.0)
+  sqlite3 (~> 1.3)

data/README.md

@@ -0,0 +1,23 @@
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Yang Ou, released under the MIT license
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/permalinkable/configure.rb

@@ -0,0 +1,15 @@
+module Permalinkable
+  class Configure
+    def self.configure
+      yield configs
+    end
+
+    def self.configs
+      @@config ||= Hashie::Mash.new
+    end
+
+    def self.key
+      @@configs.key
+    end
+  end
+end

data/lib/permalinkable/permalinkable.rb

@@ -0,0 +1,49 @@
+module Permalinkable
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def acts_as_permalinkable(options = {})
+      send :cattr_accessor, :permalink_options
+      self.permalink_options = { permalinkable_attribute: :name, permalink_field_name: :permalink,
+                                 length: 200, allow_change: false }
+      self.permalink_options.update(options) if options.is_a?(Hash)
+
+      send :include, InstanceMethods
+      send :after_save, :save_permalink
+    end
+
+    def permalink_cipher
+      cipher = OpenSSL::Cipher.new('RC4-40')
+      cipher.encrypt
+      cipher.key = Base64.urlsafe_decode64(Configure.key)
+      cipher
+    end
+  end
+
+  module InstanceMethods
+    def to_param
+      existing_permalink = send(permalink_options[:permalink_field_name])
+      (existing_permalink.present? && existing_permalink) || id.to_s
+    end
+
+    private
+    def generate_permalink
+      sanitized = self.send(permalink_options[:permalinkable_attribute]).gsub(/[^[:alnum:]]/, ' ').strip.gsub(/\W+/, '-')
+      "#{fpe}-#{sanitized}"[0..permalink_options[:length]]
+    end
+
+    def save_permalink
+      generated_permalink = generate_permalink
+      if self.send(permalink_options[:permalink_field_name]).blank? || \
+           ( permalink_options[:allow_change] && generated_permalink != self.send(permalink_options[:permalink_field_name]) )
+        self.update_column(permalink_options[:permalink_field_name].to_s, generated_permalink)
+      end
+    end
+
+    def fpe
+      @fpe ||= Base64.urlsafe_encode64(self.class.permalink_cipher.update('%11s' % self.id))
+    end
+  end
+end

data/lib/permalinkable/version.rb

@@ -0,0 +1,8 @@
+module Permalinkable
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/lib/permalinkable.rb

@@ -0,0 +1,2 @@
+require 'permalinkable/permalinkable'
+require 'permalinkable/configure'

data/permalink.gemspec

@@ -0,0 +1,42 @@
+require "./lib/permalinkable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "permalinkable"
+  s.version     = Permalinkable::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Yang Ou"]
+  s.email       = ["ouyang871223@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/permalinkable"
+  s.summary     = "Generate permalink attributes on ActiveRecord FPE'ed from database ids."
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.licenses      = ['MIT']
+  s.description   = <<-DESC
+    This is a gem originated from another gem called permalink.
+    Since I often want a permalink that provides no way to tell the database ids,
+    I came up with the idea about encrypting the id and prepending it to the permalink.
+    For more information about FPE(Format Preserving Encryption), please consult the wikipedia.
+
+    The encryption method of current release is simply RC4-40 with a configurable key.
+    Note, RC4-40 is not a strong encryption algorithm at all, and you shouldn't rely on it to delivery sensitive
+    information. Also, to prevent inconsistance of encryption, and duplication(although the chance is very low)
+    you should keep your key as a secret and never change it.
+
+    The original implementation of generating permalink involves a infite loop to check uniqueness in database.
+    It's slow, inefficient and most importantly, it still can't prevent race condition. And since we are using
+    a FPE algorithm on the database id, which is garanteed to be unique from database, we don't need to put ourselves
+    in that inefficient loop.
+
+    Finally, what's the purpose of this gem?
+    It's only a gem that helps hiding your database ids.
+  DESC
+
+  s.add_runtime_dependency "activerecord", '~> 4.0'
+  s.add_runtime_dependency "hashie", '~> 3.1'
+  s.add_development_dependency "sqlite3", '~> 1.3'
+  s.add_development_dependency "rspec", '~> 3.0'
+  s.add_development_dependency "rake", '~> 10.1'
+  s.add_development_dependency "factory_girl_rails", '~> 4.4'
+end

data/spec/permalinkable/permalinkable_spec.rb

@@ -0,0 +1,148 @@
+# require "spec_helper"
+
+# describe Permalink::ActiveRecord do
+#   let(:model) { Post }
+
+#   before do
+#     model.delete_all
+#     model.permalink :title
+#   end
+
+#   it "responds to options" do
+#     expect(model).to respond_to(:permalink_options)
+#   end
+
+#   it "uses default options" do
+#     model.permalink :title
+#     record = model.create(:title => "Some nice post")
+#     expect(record.permalink).to eq("some-nice-post")
+#   end
+
+#   it "uses custom attribute" do
+#     model.permalink :title, :to => :slug
+#     record = model.create(:title => "Some nice post")
+#     expect(record.slug).to eq("some-nice-post")
+#   end
+
+#   it "sets permalink before_save" do
+#     record = model.new(:title => "Some nice post")
+#     expect(record.permalink).to be_nil
+#     record.valid?
+#     expect(record.permalink).to eq("some-nice-post")
+#   end
+
+#   it "creates unique permalinks" do
+#     model.permalink :title, :unique => true
+
+#     record = model.create(:title => "Some nice post")
+#     expect(record.permalink).to eq("some-nice-post")
+
+#     record = model.create(:title => "Some nice post")
+#     expect(record.permalink).to eq("some-nice-post-2")
+
+#     record = model.create(:title => "Some nice post")
+#     expect(record.permalink).to eq("some-nice-post-3")
+#   end
+
+#   it "creates unique permalinks based on scope" do
+#     model.permalink :title, :unique => true, :scope => :user_id
+
+#     user = User.create!
+#     another_user = User.create!
+
+#     # Create posts for user
+#     record = model.create(:title => "Some nice post", :user => user)
+#     expect(record.permalink).to eq("some-nice-post")
+
+#     record = model.create(:title => "Some nice post", :user => user)
+#     expect(record.permalink).to eq("some-nice-post-2")
+
+#     # Create posts for another user
+#     record = model.create(:title => "Some nice post", :user => another_user)
+#     expect(record.permalink).to eq("some-nice-post")
+
+#     record = model.create(:title => "Some nice post", :user => another_user)
+#     expect(record.permalink).to eq("some-nice-post-2")
+#   end
+
+#   it "returns param for unique permalink" do
+#     model.permalink :title, :to_param => :permalink, :unique => true
+
+#     record = model.create(:title => "Ruby")
+#     expect(record.to_param).to eq("ruby")
+
+#     record = model.create(:title => "Ruby")
+#     expect(record.to_param).to eq("ruby-2")
+#   end
+
+#   it "overrides to_param with custom fields" do
+#     model.permalink :title, :to => :slug, :to_param => [:slug, :id, "page"]
+
+#     record = model.create(:title => "Some nice post")
+#     expect(record.to_param).to eq("some-nice-post-#{record.id}-page")
+#   end
+
+#   it "ignores blank attributes from to_param" do
+#     model.permalink :title, :to_param => [:id, "    ", nil, "\t", :permalink]
+
+#     record = model.create(:title => "Some nice post")
+#     expect(record.to_param).to eq("#{record.id}-some-nice-post")
+#   end
+
+#   it "sets permalink if permalink is blank" do
+#     record = model.create(:title => "Some nice post", :permalink => "  ")
+#     expect(record.permalink).to eq("some-nice-post")
+#   end
+
+#   it "keeps defined permalink" do
+#     record = model.create(:title => "Some nice post", :permalink => "awesome-post")
+#     expect(record.permalink).to eq("awesome-post")
+#   end
+
+#   it "creates unique permalinks for number-ended titles" do
+#     model.permalink :title, :unique => true
+
+#     record = model.create(:title => "Rails 3")
+#     expect(record.permalink).to eq("rails-3")
+
+#     record = model.create(:title => "Rails 3")
+#     expect(record.permalink).to eq("rails-3-2")
+#   end
+
+#   it "forces permalink" do
+#     model.permalink :title, :force => true
+
+#     record = model.create(:title => "Some nice post")
+#     record.update_attributes :title => "Awesome post"
+
+#     expect(record.permalink).to eq("awesome-post")
+#   end
+
+#   it "forces permalink and keep unique" do
+#     model.permalink :title, :force => true, :unique => true
+
+#     record = model.create(:title => "Some nice post")
+
+#     record.update_attributes :title => "Awesome post"
+#     expect(record.permalink).to eq("awesome-post")
+
+#     record = model.create(:title => "Awesome post")
+#     expect(record.permalink).to eq("awesome-post-2")
+#   end
+
+#   it "keeps same permalink when another field changes" do
+#     model.permalink :title, :force => true, :unique => true
+
+#     record = model.create(:title => "Some nice post")
+#     record.update_attributes :description => "some description"
+
+#     expect(record.permalink).to eq("some-nice-post")
+#   end
+
+#   it "overrides to_param method" do
+#     model.permalink :title
+
+#     record = model.create(:title => "Some nice post")
+#     expect(record.to_param).to eql("#{record.id}-some-nice-post")
+#   end
+# end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "bundler/setup"
+require "permalinkable"
+require 'securerandom'
+
+ActiveRecord::Base
+  .establish_connection(adapter: "sqlite3", database: ":memory:")
+
+load("support/schema.rb")
+require "support/user"
+
+Permalinkable::Configure.configure do |config|
+  config.key = SecureRandom.urlsafe_base64(9, false)
+end

data/spec/support/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users do |t|
+    t.string :user_name
+    t.string :permalink
+  end
+end

data/spec/support/user.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  include Permalinkable
+  acts_as_permalinkable permalinkable_attribute: :username, length: 100
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: permalinkable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yang Ou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: sqlite3
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+description: |2
+      This is a gem originated from another gem called permalink.
+      Since I often want a permalink that provides no way to tell the database ids,
+      I came up with the idea about encrypting the id and prepending it to the permalink.
+      For more information about FPE(Format Preserving Encryption), please consult the wikipedia.
+
+      The encryption method of current release is simply RC4-40 with a configurable key.
+      Note, RC4-40 is not a strong encryption algorithm at all, and you shouldn't rely on it to delivery sensitive
+      information. Also, to prevent inconsistance of encryption, and duplication(although the chance is very low)
+      you should keep your key as a secret and never change it.
+
+      The original implementation of generating permalink involves a infite loop to check uniqueness in database.
+      It's slow, inefficient and most importantly, it still can't prevent race condition. And since we are using
+      a FPE algorithm on the database id, which is garanteed to be unique from database, we don't need to put ourselves
+      in that inefficient loop.
+
+      Finally, what's the purpose of this gem?
+      It's only a gem that helps hiding your database ids.
+email:
+- ouyang871223@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/.DS_Store
+- lib/permalinkable.rb
+- lib/permalinkable/configure.rb
+- lib/permalinkable/permalinkable.rb
+- lib/permalinkable/version.rb
+- permalink.gemspec
+- spec/permalinkable/permalinkable_spec.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb
+- spec/support/user.rb
+homepage: http://rubygems.org/gems/permalinkable
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Generate permalink attributes on ActiveRecord FPE'ed from database ids.
+test_files:
+- spec/permalinkable/permalinkable_spec.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb
+- spec/support/user.rb
+has_rdoc: