api_key_tools 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02d4ff655e6924e64423e1a56853387f19274093
+  data.tar.gz: 274e201db90b330ecd26139ac50bcf1bd7e5ca1a
+SHA512:
+  metadata.gz: 4db8d5b10d3e3192c0ba5a202ed3b2e9e9a7175b6516f76dfe1821686390ff40f141447aed6d48466f0dfbdc6db049e9d8e0f1e61ea1ad2b8c1e5fd36ca60d39
+  data.tar.gz: b69e7436ae84c8781b1922a18b8e2eb690de1302bbf496fabf1f33bcc292e591fecc5de6848b1dd5a0b0fd8e67a06bd65e866c54dfaa2f7dc443c0de9213c401

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 api_key_tools.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', cmd: 'bundle exec rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Samuel O. Obukwelu
+
+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,38 @@
+# ApiKeyTools
+
+A small set of classes that I use to encode and validate data sent between servers
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'api_key_tools'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_key_tools
+
+## Usage
+
+To encode:
+
+    key_encoder = ApiKeyTools::Encode.new(user_id, secret, time_as_an_integer)
+    open_secret = key_encoder.to_s # this is what you want exposed not the secret
+
+To validate:
+
+    validator = ApiKeyTools::Validator.new(key_encoder, open_secret)
+    validator.valid?
+
+
+## Contributing
+
+1. Fork it ( http://github.com/fcgmedia/api_key_tools/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/api_key_tools.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_key_tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_key_tools"
+  spec.version       = ApiKeyTools::VERSION
+  spec.authors       = ["Samuel O. Obukwelu"]
+  spec.email         = ["sam@fcgmedia.com"]
+  spec.summary       = %q{A small set of tools to encode and validate data sent to api }
+  spec.description   = %q{A tool to protect api data}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "timecop"
+end

data/lib/api_key_tools/version.rb

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

data/lib/api_key_tools.rb

@@ -0,0 +1,41 @@
+require "api_key_tools/version"
+require 'digest/sha1'
+
+module ApiKeyTools
+  DELIMITER = "-"
+
+  class Encoder
+    attr_reader :time
+    def initialize(id, user_key, time)
+      @id = id
+      @user_key = user_key
+      @time = time
+    end
+
+    def to_s
+      Digest::SHA1.hexdigest([@id, @user_key, @time].join(DELIMITER))
+    end
+
+    def as_json
+      { id: @id, key: to_s, time: @time}
+    end
+  end
+
+  class Validator
+    TIME_THRESHOLD = 60 * 5 # 5 minutes or 300 seconds
+    def initialize(encoder, value)
+      @encoder = encoder
+      @value = value
+    end
+
+    def valid?
+      within_time_limit? && @encoder.to_s == @value
+    end
+
+    private
+    def within_time_limit?
+      time_now_as_int = Time.now.to_i
+      @encoder.time >= time_now_as_int && @encoder.time <= time_now_as_int + TIME_THRESHOLD
+    end
+  end
+end

data/spec/api_key_tools_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe ApiKeyTools::Encoder do
+  describe "#encode" do
+    let(:id){ 1 }
+    let(:key){ "0a185854152be354388a105a727164d3" }
+    let(:time){ Time.now.to_i }
+    subject{ described_class.new(id, key, time) }
+    it "should create a md5 hash" do
+      expect(subject.to_s).to eq("51b61e2e0569a8f8929de0cbc25714f4abadcad2")
+    end
+
+    it "should create a valid as_json value" do
+      expect(subject.as_json).to eq({ id: 1, key: "51b61e2e0569a8f8929de0cbc25714f4abadcad2", time: time })
+    end
+  end
+end
+
+describe ApiKeyTools::Validator do
+  describe "#valid?" do
+    let(:id){ 1 }
+    let(:key){ "0a185854152be354388a105a727164d3" }
+    let(:time){ Time.now.to_i }
+    let(:encoder){ ApiKeyTools::Encoder.new(id, key, time) }
+    subject{ ApiKeyTools::Validator.new(encoder, value) }
+    context "valid value" do
+      let(:value){ "51b61e2e0569a8f8929de0cbc25714f4abadcad2" }
+      it "should be true" do
+        expect(subject.valid?).to eq(true)
+      end
+    end
+
+    context "valid value but pass the time limit" do
+      let(:value){ "51b61e2e0569a8f8929de0cbc25714f4abadcad2" }
+      it "should be false" do
+        subject
+        Timecop.travel(Time.now + 10_000)
+        expect(Time.at(time)).to_not eq(Time.now)
+        expect(subject.valid?).to eq(false)
+      end
+    end
+
+    context "invalid value" do
+      let(:value){ "BAD_VALUE" }
+      it "should be false" do
+        expect(subject.valid?).to eq(false)
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'pry'
+require 'api_key_tools'
+Dir[
+  './spec/support/*.rb'
+].each do |f|
+  require f
+end
+

data/spec/support/timecop.rb

@@ -0,0 +1,11 @@
+require 'timecop'
+RSpec.configure do |config|
+  config.before(:each) do
+    Timecop.freeze(Time.local(2010, 1, 1))
+  end
+
+  config.after(:each) do
+    Timecop.return
+  end
+end
+

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: api_key_tools
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Samuel O. Obukwelu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: guard
+  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: guard-rspec
+  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: pry
+  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: timecop
+  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: A tool to protect api data
+email:
+- sam@fcgmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_key_tools.gemspec
+- lib/api_key_tools.rb
+- lib/api_key_tools/version.rb
+- spec/api_key_tools_spec.rb
+- spec/spec_helper.rb
+- spec/support/timecop.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A small set of tools to encode and validate data sent to api
+test_files:
+- spec/api_key_tools_spec.rb
+- spec/spec_helper.rb
+- spec/support/timecop.rb
+has_rdoc: