key_store 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9f84301f0857cc3b7b0090b554914a680ada02b
+  data.tar.gz: 49de7e8df07c0730d79fbbca051742e282956abe
+SHA512:
+  metadata.gz: 79b5ad463d132b39486f9fa7e82150f764861d74823b1e3595b8c7ae2c43001939c3394038edb8728407b91208c3c238415db5691c0a820aabc7cd82f86e5fb5
+  data.tar.gz: 76f666c6ca5375da6e83df7b01f162182bb354142a3ef9626f418a97c639082993ae93f2c840bdd472be1e1ef7cbb38c4c46b55dd8cc492ac71edcf4ba1046da

data/lib/key_store.rb

@@ -0,0 +1,55 @@
+require "yaml/store"
+require "thread"
+require "fileutils"
+require_relative "key_store/key"
+require_relative "key_store/version"
+
+module KeyStore
+
+  class << self
+
+    attr_reader :file_path
+
+    def set_file_path(value)
+      @file_path = value
+    end
+
+    def file
+      if @file.nil? || modified?
+        Mutex.new.synchronize do
+          @file = begin
+            raise "file_path not set" if file_path.nil?
+            FileUtils.touch(file_path) unless File.exists?(file_path)
+            self.mtime = File.mtime(file_path)
+            YAML::Store.new(file_path, true)
+          end
+        end
+      end
+      @file
+    end
+
+    def exists?(name)
+      !!(file.transaction { file[name.to_s] })
+    end
+
+    def find(name)
+      exists?(name) ? KeyStore::Key.new(name) : nil
+    end
+
+    def delete!(name)
+      file.transaction { file.delete(name.to_s) }
+    end
+
+    private
+
+    attr_accessor :mtime
+
+    def modified?
+      return true if mtime.nil? || !File.exists?(file_path)
+      File.mtime(file_path) != mtime
+    end
+
+  end
+
+end
+

data/lib/key_store/key.rb

@@ -0,0 +1,52 @@
+require "forwardable"
+
+module KeyStore
+  class Key
+    extend Forwardable
+
+    def_delegators :KeyStore, :file, :exists?
+    attr_reader :name, :roles
+    attr_accessor :notes
+    alias_method :to_s, :name
+
+    def initialize(name, roles: nil, notes: nil)
+      @name = name.to_s
+
+      if exists?(name)
+        set_roles_from_file if roles.nil?
+        set_notes_from_file if notes.nil?
+      end
+
+      @roles ||= (roles || []).map(&:to_s)
+      @notes ||= notes.to_s
+    end
+
+    def http_header
+      "Authorization: Token token=\"#{name}\""
+    end
+
+    def save!
+      file.transaction do
+        file[name] ||= {}
+        file[name][:roles] = roles.map(&:to_s)
+        file[name][:notes] = notes.to_s
+        file[name][:http_header] = http_header
+      end
+    end
+
+    private
+
+    def set_roles_from_file
+      file.transaction do
+        @roles = file[name][:roles]
+      end
+    end
+
+    def set_notes_from_file
+      file.transaction do
+        @notes = file[name][:notes]
+      end
+    end
+
+  end
+end

data/lib/key_store/version.rb

@@ -0,0 +1,3 @@
+module KeyStore
+  VERSION = "0.0.3"
+end

data/test/key_store_test.rb

@@ -0,0 +1,45 @@
+require_relative "test_helper"
+
+class KeyStoreTest < MicroTest::Test
+
+  before do
+    @file_path = File.expand_path("../keys.yml", __FILE__)
+    KeyStore.set_file_path @file_path
+    KeyStore.delete!(:foobar)
+  end
+
+  test "set_file_path" do
+    assert KeyStore.file_path == @file_path
+  end
+
+  test "file errors with nil file_path" do
+    KeyStore.instance_eval do
+      @file_path = @file = nil
+    end
+
+    begin
+      assert KeyStore.file
+    rescue Exception => e
+      error = e
+    end
+
+    assert !error.nil?
+  end
+
+  test "file success with valid file_path" do
+    assert KeyStore.file
+  end
+
+  test "unknown key does not exist" do
+    assert KeyStore.exists?(:foobar) == false
+  end
+
+  test "find returns nil on unknown key" do
+    assert KeyStore.find(:foobar).nil?
+  end
+
+  test "ok to call delete! on unknown key" do
+    assert KeyStore.delete!(:foobar).nil?
+  end
+
+end

data/test/key_test.rb

@@ -0,0 +1,84 @@
+require_relative "test_helper"
+
+class KeyTest < MicroTest::Test
+
+  before do
+    @file_path = File.expand_path("../keys.yml", __FILE__)
+    KeyStore.set_file_path @file_path
+    KeyStore.delete!(:foobar)
+  end
+
+  test "name set on initialize" do
+    key = KeyStore::Key.new(:foobar)
+    assert key.name == "foobar"
+  end
+
+  test "initialize doesn't save key" do
+    assert KeyStore.exists?(:foobar) == false
+    KeyStore::Key.new(:foobar)
+    assert KeyStore.exists?(:foobar) == false
+  end
+
+  test "initialize with roles" do
+    roles = [:foo, :bar, :baz]
+    key = KeyStore::Key.new(:foobar, roles: roles)
+    assert key.roles == roles.map(&:to_s)
+  end
+
+  test "initialize with notes" do
+    notes = "There are notes."
+    key = KeyStore::Key.new(:foobar, notes: notes)
+    assert key.notes == notes
+  end
+
+  test "http_header after initialize" do
+    key = KeyStore::Key.new(:foobar)
+    assert key.http_header == "Authorization: Token token=\"foobar\""
+  end
+
+  test "basic save" do
+    key = KeyStore::Key.new(:foobar)
+    key.save!
+    assert KeyStore.exists?(:foobar)
+  end
+
+  test "save with roles" do
+    roles = [:foo, :bar, :baz]
+    key = KeyStore::Key.new(:foobar, roles: roles)
+    key.save!
+    key = KeyStore.find(:foobar)
+    assert key.roles == roles.map(&:to_s)
+  end
+
+  test "save with notes" do
+    notes = "There are notes."
+    key = KeyStore::Key.new(:foobar, notes: notes)
+    key.save!
+    key = KeyStore.find(:foobar)
+    assert key.notes == notes
+  end
+
+  test "append roles & multiple saves" do
+    key = KeyStore::Key.new(:foobar, roles: [:foo])
+    key.save!
+    key = KeyStore.find(:foobar)
+    key.roles << :bar
+    key.roles << :baz
+    key.save!
+    key = KeyStore.find(:foobar)
+    assert key.roles == [:foo, :bar, :baz].map(&:to_s)
+  end
+
+  test "update notes" do
+    key = KeyStore::Key.new(:foobar, notes: "note 1")
+    key.save!
+    key = KeyStore.find(:foobar)
+    assert key.notes == "note 1"
+    key.notes = "note 2"
+    key.save!
+    key = KeyStore.find(:foobar)
+    assert key.notes == "note 2"
+  end
+
+end
+

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require "micro_test"
+require_relative "../lib/key_store"

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: key_store
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Nathan Hopkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: micro_test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: A simple api-key storage engine
+email:
+- natehop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/key_store/key.rb
+- lib/key_store/version.rb
+- lib/key_store.rb
+- test/key_store_test.rb
+- test/key_test.rb
+- test/test_helper.rb
+homepage: https://github.com/hopsoft/key_store
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.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: A simple api-key storage engine
+test_files:
+- test/key_store_test.rb
+- test/key_test.rb
+- test/test_helper.rb
+has_rdoc: