mongo_mapper-token_keys 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3273be071c93636df1e9002f5f6022e80736ab1b
+  data.tar.gz: 2f34e7ab2785c56c8fcce384e77dc39622016968
+SHA512:
+  metadata.gz: 2d2fd2f8dc6cb0b8a23257ec477754be6f965ef23ef9a13d1d389f41961a37b82315161b0d25c00724c69d3acc1d910b6769394c65c62d74df793416f6cecf82
+  data.tar.gz: 7d29c7c307f66e269a54b5ab80383d75115e95c5a3492cafd084a219926bf5f019e141398f7ff2798ca2c836995e65ec85849a83256ef2bfd2cd45ed1d28a182

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Bleigh
+
+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/README.md

@@ -0,0 +1,55 @@
+# MongoMapper::TokenKeys
+
+MongoMapper::TokenKeys provides a simple way to add randomized, url safe tokens to
+your MongoMapper models. Formerly a [gem in a gist](https://gist.github.com/mbleigh/1428845),
+it's now a full-blown RubyGem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongomapper-tokenkeys'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongomapper-tokenkeys
+
+## Usage
+
+```ruby
+require 'mongo_mapper/token_keys'
+
+class User
+  key :name
+  token :api_token, size: 30
+end
+
+user = User.create(name: 'Bob')
+user.api_token # => 2Hj5GGvWsyI78yCe8j8uOSfDP0w2yWhJBJ0Y9EmS
+```
+
+## License
+
+Copyright (c) 2011-2013 Michael Bleigh
+
+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/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task default: :spec

data/lib/mongo_mapper/token_keys.rb

@@ -0,0 +1,36 @@
+require "mongo_mapper/token_keys/version"
+
+require 'mongo_mapper'
+require 'securerandom'
+
+module MongoMapper
+  module TokenKeys
+    extend ActiveSupport::Concern
+    DEFAULT_SIZE = 20
+
+    def self.generate(size = DEFAULT_SIZE)
+      SecureRandom.urlsafe_base64(size)
+    end
+
+    module ClassMethods
+      def tokens
+        @tokens ||= {}
+      end
+
+      def token(name, options = {})
+        key name, String, options
+        tokens[name.to_sym] = options.delete(:size) || DEFAULT_SIZE
+
+        if tokens.size == 1
+          before_validation(:on => :create) do
+            self.class.tokens.each_pair do |token, size|
+              self[token] ||= MongoMapper::TokenKeys.generate(size)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+MongoMapper::Document.plugin(MongoMapper::TokenKeys)

data/lib/mongo_mapper/token_keys/version.rb

@@ -0,0 +1,5 @@
+module MongoMapper
+  module TokenKeys
+    VERSION = "0.1.0"
+  end
+end

data/mongo_mapper-token_keys.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongo_mapper/token_keys/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'mongo_mapper-token_keys'
+  s.version     = MongoMapper::TokenKeys::VERSION
+  s.author      = 'Michael Bleigh'
+  s.email       = 'mbleigh@mbleigh.com'
+  s.summary     = 'Add simple autogenerated tokens to your MongoMapper models.'
+  s.description = 'Add simple autogenerated tokens to your MongoMapper models.'
+  s.homepage    = 'https://github.com/mbleigh/mongo_mapper-token_keys'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split($/)                                                                                                                                                                                                      
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }                                                                                                                                                                           
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})                                                                                                                                                                                   
+  s.require_paths = ["lib"]
+
+  s.add_dependency('mongo_mapper')
+  s.add_development_dependency('rspec', ["~> 2.0"])
+end
+

data/spec/mongo_mapper/token_keys_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe MongoMapper::TokenKeys do
+  let(:doc){ k = Class.new; k.send(:include, MongoMapper::Document); k }
+
+  it 'should be available by default on documents' do
+    doc.ancestors.should be_include(MongoMapper::TokenKeys)
+  end
+
+  it 'should provide a .token method' do
+    doc.should be_respond_to(:token)
+  end
+
+  it 'should call through to .key when token is called' do
+    doc.should_receive(:key).with(:example, String, {})
+    doc.token :example
+  end
+
+  it 'should keep track of the token (and any supplied size)' do
+    doc.token :first
+    doc.token :second, :size => 10
+
+    doc.tokens.should == {:first => MongoMapper::TokenKeys::DEFAULT_SIZE, :second => 10}
+  end
+
+  it 'should automatically generate tokens on validation' do
+    doc.token :example
+    instance = doc.new
+    MongoMapper::TokenKeys.should_receive(:generate).with(MongoMapper::TokenKeys::DEFAULT_SIZE).and_return('abc')
+    instance.example.should be_nil
+    instance.valid?
+    instance.example.should == 'abc'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'bundler'
+Bundler.setup :default, :test
+
+require 'mongo_mapper/token_keys'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: mongo_mapper-token_keys
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Add simple autogenerated tokens to your MongoMapper models.
+email: mbleigh@mbleigh.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongo_mapper/token_keys.rb
+- lib/mongo_mapper/token_keys/version.rb
+- mongo_mapper-token_keys.gemspec
+- spec/mongo_mapper/token_keys_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mbleigh/mongo_mapper-token_keys
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Add simple autogenerated tokens to your MongoMapper models.
+test_files:
+- spec/mongo_mapper/token_keys_spec.rb
+- spec/spec_helper.rb