permalinkable 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 917d1aae3fcb6fc297bd8eeccff7fbe083ad3271
-  data.tar.gz: 1ca4b745e27f77cadcf6221885a920c89cc5485b
+  metadata.gz: b05ab93469a89d4beee2783d29eb52f973dbbb2b
+  data.tar.gz: b28eb5e76a637aee2860c7d93721f889b0e67545
 SHA512:
-  metadata.gz: 895dfc0204ac64e66ba324dbc42e24fd2c28fb4d8da52473546e5fa5b4334dcb18df5442599200b174c2d9077cefe2b55ca994f30e3c659ece7880d79f7cd2e7
-  data.tar.gz: d40972d8bdced2b8ce3164bf0b5b17245f720df4a27c1bc2c4acb3815a2101228542401db06f304407619dbc66b4fc86efcead26b205758ecd2324f52d031edc
+  metadata.gz: 1ab5cea1e18446b55fe30646752686a45c5b3b1e8a61ad666d7523d93f010d819828b1576697b8e9d439755e35956ba71d5b58ea9cce8c60a6517c75a37807a2
+  data.tar.gz: 1537643b9ea13980eadaaf34108ac4d944d869a2774f70f7b9ace857ddb2fc97553814b62b690e99ab718c3306132e0f626da6b1a9d80c7b570eb307830ff3af

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+script: bundle exec rspec

data/Gemfile.lock

@@ -1,22 +1,13 @@
 PATH
   remote: .
   specs:
-    permalinkable (0.1.0)
+    permalinkable (1.0.1)
       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)
@@ -33,25 +24,10 @@ GEM
     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)
@@ -65,7 +41,6 @@ GEM
       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)
@@ -74,8 +49,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  factory_girl_rails (~> 4.4)
   permalinkable!
-  rake (~> 10.1)
   rspec (~> 3.0)
   sqlite3 (~> 1.3)

data/README.md

@@ -1,3 +1,47 @@
+# Permalinkable, inspired by [permalink](https://github.com/fnando/permalink)
+
+[![Code Climate](https://codeclimate.com/github/yangou/permalinkable.png)](https://codeclimate.com/github/yangou/permalinkable)[![Build Status](https://travis-ci.org/yangou/permalinkable.svg)](https://travis-ci.org/yangou/permalinkable)
+
+## Purpose & Note
+This is a gem inspired from another gem called [permalink](https://github.com/fnando/permalink). Since I often want a permalink that provides no way to tell the database ids,
+I finally came up with the idea about encrypting and prepending it to the original permalink.
+The encryption is implemented with a simple FED algorithm. For more information about FPE(Format Preserving Encryption), please consult the [wikipedia](http://en.wikipedia.org/wiki/Format-preserving_encryption) page.
+
+The encryption method of current release is a simple "RC4-40" with a configurable key.
+Note that "RC4-40" is NOT a strong encryption algorithm at all, and you SHOULDN'T rely on it to delivery sensitive information. Also, to prevent inconsistency of encryption, and duplication(although the chance is very low), you should keep your key as a secret and never change it in production.
+
+The original implementation of generating permalink involves an infite loop to check the uniqueness in database. It's slow, inefficient and most importantly, it still can't prevent race condition in rails. Since we are now using a FPE algorithm based on database id, which is garanteed to be unique from database, we don't need to put ourselves in that inefficient loop any more.
+
+#####Finally, in short ,what's the purpose of this gem?
+
+It's only a gem that helps hiding your database ids.
+
+## Instalation
+
+    gem install permalinkable
+
+## Usage
+
+Include the `Permalinkable` module into your model. And call `acts_as_permalinkable` with some parameters.
+
+```ruby
+class User < ActiveRecord::Base
+  include Permalinkable
+  acts_as_permalinkable permalinkable_attribute: :user_name, length: 100, allow_change: true, permalink_field_name: :permalink
+end
+```
+And don't forget to create the migration for you permalink column.
+
+#### Usage on options:
+
+options                         | descriptions 
+:-----------                    | :----------- 
+permalinkable_attribute         | the attribute that you want your permalink to be based on.        
+permalink_field_name            | the column name that you want to store your permalink        
+length                          | the maximum length for your permalink
+allow_change                    | by default it's false so that once a permalink is set, it can never be changed. Setting it to true will allow it to be changed along with the permalinkable_attribute.
+
+
 ## License
 
 The MIT License (MIT)
@@ -20,4 +64,4 @@ 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.
+THE SOFTWARE.

data/lib/permalinkable.rb

@@ -1,2 +1,3 @@
-require 'permalinkable/permalinkable'
-require 'permalinkable/configure'
+require 'active_record'
+require 'permalinkable/configure'
+require 'permalinkable/permalinkable'

data/lib/permalinkable/configure.rb

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

data/lib/permalinkable/permalinkable.rb

@@ -1,3 +1,5 @@
+require 'securerandom'
+
 module Permalinkable
   def self.included(base)
     base.extend ClassMethods
@@ -9,15 +11,18 @@ module Permalinkable
       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)
+      self.permalink_options.freeze
 
       send :include, InstanceMethods
       send :after_save, :save_permalink
+      send :attr_readonly, permalink_options[:permalink_field_name]
+      send :validates, permalink_options[:permalinkable_attribute], presence: true, length: { minimum: 0 }
     end
 
     def permalink_cipher
       cipher = OpenSSL::Cipher.new('RC4-40')
       cipher.encrypt
-      cipher.key = Base64.urlsafe_decode64(Configure.key)
+      cipher.key = Base64.urlsafe_decode64(Configure.secret)
       cipher
     end
   end
@@ -38,7 +43,8 @@ module Permalinkable
       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)
+        self.class.unscoped.where(self.class.primary_key => self.id).update_all( permalink_options[:permalink_field_name].to_s => generated_permalink )
+        raw_write_attribute(permalink_options[:permalink_field_name].to_s, generated_permalink)
       end
     end
 

data/lib/permalinkable/version.rb

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

data/permalink.gemspec

@@ -37,6 +37,4 @@ Gem::Specification.new do |s|
   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

@@ -1,148 +1,85 @@
-# 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
+require "spec_helper"
+
+describe Permalinkable do
+  context "Non-changable permalink" do
+    before(:each) do
+      User.delete_all
+      Entry.delete_all
+    end
+
+    it 'injects permalink_options as class attribute to the model' do
+      expect(User.permalink_options).to include({
+            :permalinkable_attribute => :user_name,
+               :permalink_field_name => :permalink,
+                             :length => 100,
+                       :allow_change => false
+      })
+    end
+
+    it 'prevents permalink_options from being modified' do
+      expect{ User.permalink_options.merge!(test: 1) }.to raise_error(RuntimeError)
+    end
+
+    it 'adds presence and non-empty validation on permalinkable_attribute' do
+      expect(User.create.errors.messages).to include({
+        user_name: ["can't be blank", "is too short (minimum is 0 characters)"]
+      })
+
+      expect(Entry.create.errors.messages).to include({
+        entry_name: ["can't be blank", "is too short (minimum is 0 characters)"]
+      })
+    end
+
+    it 'generates permalink for new model' do
+      u = User.create(user_name: 'test user')
+      expect(u.permalink).not_to be_empty()
+
+      e = Entry.create(entry_name: 'test entry')
+      expect(e.entry_identity).not_to be_empty()
+    end
+
+    it 'generates decrypteable permalink' do
+      u = User.create(user_name: 'test user')
+      dec = User.permalink_cipher
+      dec.decrypt
+      expect(
+        dec.update(Base64.urlsafe_decode64(u.permalink.gsub("-test-user", ''))).strip
+      ).to eq(u.id.to_s)
+    end
+
+    it 'prevents permalink to be manully modified' do
+      u = User.create(user_name: 'test user')
+      permalink = u.permalink
+      u.update_attributes(permalink: '123123') && u.reload
+      expect(u.permalink).to eq(permalink)
+
+      e = Entry.create(entry_name: 'test entry')
+      permalink = e.entry_identity
+      e.update_attributes(entry_identity: '123123') && e.reload
+      expect(e.entry_identity).to eq(permalink)
+    end
+
+    it 'makes to_param to return permalink if available' do
+      u = User.create(user_name: 'test user')
+      expect(u.permalink).to eq(u.to_param)
+
+      e = Entry.create(entry_name: 'test entry')
+      expect(e.entry_identity).to eq(e.to_param)
+    end
+  end
+
+  context "Changable permalink" do
+    before(:each) do
+      Entry.delete_all
+    end
+
+    it 'changes permalink once permalinkable_attribute changes' do
+      e = Entry.create(entry_name: 'test entry')
+      old_permalink = e.entry_identity
+      e.update_attributes(entry_name: 'changed entry')
+      new_permalink = e.entry_identity
+      expect(old_permalink).not_to eq(new_permalink)
+      expect(old_permalink.first(4)).to eq(new_permalink.first(4))
+    end
+  end
+end

data/spec/spec_helper.rb

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

data/spec/support/entry.rb

@@ -0,0 +1,4 @@
+class Entry < ActiveRecord::Base
+  include Permalinkable
+  acts_as_permalinkable permalinkable_attribute: :entry_name, length: 100, allow_change: true, permalink_field_name: :entry_identity
+end

data/spec/support/schema.rb

@@ -3,4 +3,9 @@ ActiveRecord::Schema.define(:version => 0) do
     t.string :user_name
     t.string :permalink
   end
+
+  create_table :entries do |t|
+    t.string :entry_name
+    t.string :entry_identity
+  end
 end

data/spec/support/user.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: permalinkable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Yang Ou
@@ -66,34 +66,6 @@ dependencies:
     - - "~>"
       - !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,
@@ -122,17 +94,20 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rvmrc"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
 - lib/.DS_Store
 - lib/permalinkable.rb
+- lib/permalinkable/.DS_Store
 - 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/entry.rb
 - spec/support/schema.rb
 - spec/support/user.rb
 homepage: http://rubygems.org/gems/permalinkable
@@ -162,6 +137,7 @@ summary: Generate permalink attributes on ActiveRecord FPE'ed from database ids.
 test_files:
 - spec/permalinkable/permalinkable_spec.rb
 - spec/spec_helper.rb
+- spec/support/entry.rb
 - spec/support/schema.rb
 - spec/support/user.rb
 has_rdoc: