Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A ruby gem that helps you generate a randomized api key string.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .rspec
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 CHANGELOG.md
Octocat-spinner-32 Gemfile
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 api_key_maker.gemspec
README.md

API Key Maker Build Status

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.

gem "api_key_maker"

Requires Ruby 1.9.2 or later.

Usage

Whenever you need to generate a key, just call the following method:

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:

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. 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.

Something went wrong with that request. Please try again.