hashids_uri 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6dd66e4364dee24a1c249da3592496b7ffa0e2ce
+  data.tar.gz: 5b366e40638fc62f9d34132c6cf64b4b2cdedb63
+SHA512:
+  metadata.gz: b9d8e1027f8229dc5d70df0f2bbb3d3bbec8aed2d84969093d467a0b43e72dee7d43b4630aa10cc004f5cbfa78095c10c14cb0ac36341828cc79a6384c6b133c
+  data.tar.gz: 71462d177e025118036561c6011a7f407462053309ad7b305e8b81ae1736e8897fbb999ffe05a96a5565aefa4d72eb66d2c18ea26463215ac7d62e4c8179c072

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at hello@danieldraper.com.au. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hashids_uri.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel Draper
+
+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/README.md

@@ -0,0 +1,59 @@
+# HashidsUri
+
+HashidsUri allows you to easily use (Hashids)[http://hashids.org/] in your Ruby on Rails URLs via the (Hashids Gem)[https://github.com/peterhellberg/hashids.rb]. You no longer need to expose sequential IDs to your users and you can do all this without changing your primary key to a UUID or some custom database level function.
+
+An example URL using HashidsUri
+```http
+https://example.com/lejRej
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hashids_uri'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hashids_uri
+
+## Usage
+
+Getting started is easy, you include the following in your model:
+
+```ruby
+def User < ActiveRecord::Base
+    has_hashids_uri
+end
+```
+
+By default the underlying Hashids gem does not provide a unique salt when creating a hash, this will lead to the same hash for each model with the same ID. If you require a unique hash you can provide a salt when initializing HashidsUri.
+
+```ruby
+def User < ActiveRecord::Base
+    has_hashids_uri salt: '1ac206225a7806'
+end
+```
+
+You can also specify the minimum length your hash should be by passing the `min_length` option during initialization.
+
+```ruby
+def User < ActiveRecord::Base
+    has_hashids_uri min_length: 6
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/danieldraper/hashids_uri. 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
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+Bundler::GemHelper.install_tasks
+
+task :test do
+  Dir.chdir('test')
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << '../lib'
+  t.libs << '../test'
+  t.test_files = FileList['*_test.rb']
+  t.verbose = false
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hashids_uri"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hashids_uri.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hashids_uri/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hashids_uri"
+  spec.version       = HashidsUri::VERSION
+  spec.authors       = ["Daniel Draper"]
+  spec.email         = ["hello@danieldraper.com.au"]
+
+  spec.summary       = %q{Use HashidsUri to hide your sequential ids from the URL.}
+  spec.description   = %q{HashidsUri turns your sequentially generated id in the URL into a Hashid see **hashids.org**.}
+  spec.homepage      = "https://github.com/danieldraper/hashids_uri"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+  spec.add_dependency "hashids",      "~> 1.0.2"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/hashids_uri/version.rb

@@ -0,0 +1,3 @@
+module HashidsUri
+  VERSION = "0.1.1"
+end

data/lib/hashids_uri.rb

@@ -0,0 +1,50 @@
+require 'hashids'
+require 'active_record'
+
+module ActiveRecord
+  module HashidsUri
+    extend ::ActiveSupport::Concern
+
+    class << self
+      attr_accessor :salt, :min_length
+    end
+
+    module ClassMethods
+      def has_hashids_uri(options = {})
+        ActiveRecord::HashidsUri.salt       = options.fetch(:salt, '')
+        ActiveRecord::HashidsUri.min_length = options.fetch(:min_length, 6)
+
+        include InstanceMethods
+      end
+    end
+
+    module ClassMethods
+      def find_by_hash(hash)
+        find(
+          ::Hashids.new(
+            ActiveRecord::HashidsUri.salt,
+            ActiveRecord::HashidsUri.min_length,
+          ).decode(hash).first
+        )
+      end
+
+      def find(*args)
+        id = args.first
+        return super if args.count != 1 || (Integer(id) rescue false)
+        find_by_hash(id).tap { |result| return result unless result.nil? }
+        raise ActiveRecord::RecordNotFound, "cannot find record with hash id: #{id.inspect}"
+      end
+    end
+
+    module InstanceMethods
+      def to_param
+        ::Hashids.new(
+          ActiveRecord::HashidsUri.salt,
+          ActiveRecord::HashidsUri.min_length
+        ).encode(id)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActiveRecord::HashidsUri)

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: hashids_uri
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Daniel Draper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashids
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: HashidsUri turns your sequentially generated id in the URL into a Hashid
+  see **hashids.org**.
+email:
+- hello@danieldraper.com.au
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hashids_uri.gemspec
+- lib/hashids_uri.rb
+- lib/hashids_uri/version.rb
+homepage: https://github.com/danieldraper/hashids_uri
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Use HashidsUri to hide your sequential ids from the URL.
+test_files: []