api_key_maker 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Johnathan Pulos
+
+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,35 @@
+# API Key Maker
+
+Using SHA1 encryption and the current time, this gem generates a random string that is useful for API keys.  The length of the string can be set as an attribute up to 39 characters in length.  This is my attempt at creating a gem.
+
+## Installation
+Add to your Gemfile and run the `bundle` command to install it.
+
+```ruby
+gem "api_key_maker"
+```
+
+**Requires Ruby 1.9.2 or later.**
+
+## Usage
+Whenever you need to generate a key, just call the following method:
+
+```ruby
+ApiKeyMaker.make_api_key(10)
+```
+The first parameter tells what length you want the key to be.  It defaults to 10 characters, but can go up to 39 characters in length.
+
+If you want an attribute of a model to default to an api key, then just add the following in your model:
+
+```ruby
+class ApiAccess < ActiveRecord::Base
+  make_api_key :api_token, 13
+end
+```
+
+This method takes 2 parameters.  The first is the attribute that will be set to the api key.  The second is the length (1-39 defaults to 10) of the string you want.  This api key is generated before the model's validation.
+
+## Development
+Questions or problems? Please post them on the [issue tracker](https://github.com/codemis/api_key_maker/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests passing by running `bundle` and `rake`.
+
+This gem is created by Johnathan Pulos and is under the MIT License.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+Rspec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/api_key_maker.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "api_key_maker/version"
+
+Gem::Specification.new do |s|
+  s.name        = "api_key_maker"
+  s.version     = ApiKeyMaker::VERSION
+  s.authors     = ["Johnathan Pulos"]
+  s.email       = ["johnathan@still-water.com"]
+  s.homepage    = "https://github.com/codemis/api_key_maker"
+  s.summary     = %q{Generates a random unique api key string}
+  s.description = %q{Using SHA1 encryption and the current time, this gem generates a random string that is useful for API keys.  The length of the string can be set as an attribute up to 39 characters in length.}
+
+  s.rubyforge_project = "api_key_maker"
+
+  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.add_development_dependency "rspec"
+  s.add_development_dependency "supermodel"
+end

data/lib/api_key_maker.rb

@@ -0,0 +1,13 @@
+require "api_key_maker/version"
+require "api_key_maker/model_additions"
+require "api_key_maker/railtie" if defined? Rails
+require "digest/sha1"
+
+module ApiKeyMaker
+  
+  # Create an API Key
+  def self.make_api_key(length = 10)
+    Digest::SHA1.hexdigest(Time.now.to_s + rand(12341234).to_s)[1..length]
+  end
+  
+end

data/lib/api_key_maker/model_additions.rb

@@ -0,0 +1,11 @@
+module ApiKeyMaker
+  module ModelAdditions
+    
+    def make_api_key(attribute, length = 10)
+      before_validation do
+        send("#{attribute}=", ApiKeyMaker.make_api_key(length))
+      end
+    end
+    
+  end
+end

data/lib/api_key_maker/railtie.rb

@@ -0,0 +1,9 @@
+module ApiKeyMaker
+  class Railtie < Rails::Railtie
+    initializer 'api_key_maker.model_additions' do
+      ActiveSupport.on_load :active_record do
+        extend ModelAdditions
+      end
+    end
+  end
+end

data/lib/api_key_maker/version.rb

@@ -0,0 +1,3 @@
+module ApiKeyMaker
+  VERSION = "0.0.1"
+end

data/spec/api_key_maker/model_additions_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+class ApiAccess < SuperModel::Base
+  include ActiveModel::Validations::Callbacks
+  extend ApiKeyMaker::ModelAdditions
+  attr_accessor :api_token, :api_special_token
+  make_api_key :api_token, 13
+  make_api_key :api_special_token
+end
+
+describe ApiKeyMaker::ModelAdditions do
+  
+  it "should create the api_token upon saving" do
+    ApiAccess.create!().api_token.blank?.should be_false
+  end
+  
+  it "should create the api_token upon saving to a length of 13 characters" do
+    ApiAccess.create!().api_token.length.should eq(13)
+  end
+  
+  it "should create the api_special_token upon saving" do
+    ApiAccess.create!().api_special_token.blank?.should be_false
+  end
+  
+  it "should create the api_special_token upon saving to a default of 10 characters" do
+    ApiAccess.create!().api_special_token.length.should eq(10)
+  end
+end

data/spec/api_key_maker_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe ApiKeyMaker do
+  
+  it "should create an api key" do
+    ApiKeyMaker.make_api_key.blank?.should be_false
+  end
+  
+  it "should create an api key to a set length" do
+    ApiKeyMaker.make_api_key(5).length.should eq(5)
+  end
+  
+  it "should create an api key to a default length" do
+    ApiKeyMaker.make_api_key.length.should eq(10)
+  end
+  
+  it "should return 39 characters even though you ask for more" do
+    ApiKeyMaker.make_api_key(80).length.should eq(39)
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'api_key_maker'
+require 'supermodel'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: api_key_maker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Johnathan Pulos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156061700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156061700
+- !ruby/object:Gem::Dependency
+  name: supermodel
+  requirement: &2156060020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156060020
+description: Using SHA1 encryption and the current time, this gem generates a random
+  string that is useful for API keys.  The length of the string can be set as an attribute
+  up to 39 characters in length.
+email:
+- johnathan@still-water.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- api_key_maker.gemspec
+- lib/api_key_maker.rb
+- lib/api_key_maker/model_additions.rb
+- lib/api_key_maker/railtie.rb
+- lib/api_key_maker/version.rb
+- spec/api_key_maker/model_additions_spec.rb
+- spec/api_key_maker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/codemis/api_key_maker
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: api_key_maker
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Generates a random unique api key string
+test_files:
+- spec/api_key_maker/model_additions_spec.rb
+- spec/api_key_maker_spec.rb
+- spec/spec_helper.rb