thyng 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4c7db9aae62d6681d2dd971af42314dc2ea35fc
-  data.tar.gz: 9034618eaa475198878a3118f98cc4c0fef811f3
+  metadata.gz: e0b5dc2a14fbbdd60ebf9ccabf39ba7941135625
+  data.tar.gz: 68e9d08bda758ec2cccb6757a000aaaa87b81f69
 SHA512:
-  metadata.gz: ea41f1e43df85be3bdd184e86bc6fd8312fec68d9c6712658eeaf30e3169b1b57e0055a9e56220ec42e8db723edaa515fa937cbfc9d4820065b3b3e439b86af5
-  data.tar.gz: 96cda3cee7960ec56f2950770977266a3ea920dce091ade504f334d024ca2190a4cdb4314231c53b3dbd97d4c6207ca3a325c553e4872c17de208ef5189d5a02
+  metadata.gz: 5b0163c7ad518c69df3795cdc8389b74892722a523cc8db8b75d64b5ceae86f10fd9efcf1ee0b6c73ee6e4d143f8a3c1437a8e1686a0e3230b87eb5a8fd8b98f
+  data.tar.gz: 27f6f95c63327a67fa76ca4d190b95cfbc31baf80cdd36eff8f54d371941e2758a98fb650d53d4e648492490d717db3969b8ed74f53c866ffe0814efd644510c

data/README.md

@@ -2,16 +2,16 @@
 
 ##### Ruby objects with public state to encourage storage as data only collections.
 
-### What?
+#### What?
 A `thyng` is a ruby object with the convention of saving state in **key:value** pairs that are public on the object rather than in private **instance variables**.
 
-### How?
+#### How?
 Instead of private attributes a `thyng` has public aspects. Basic access to these can be declared with `asect_reader`, `aspect_write` & `aspect_accessor`.
 
-### Why?
-Will all internal state a `thyng` can be reconstructed completly from its data. This allows it to be passed as JSON a json object and easily be stored in a database.
+#### Why?
+With all state external a `thyng` can be reconstructed completly from its data. This allows it to be passed as JSON or easily stored in a database.
 
-### Simple example
+#### Simple example
 
 ```ruby
 class Person < Thyng
@@ -27,7 +27,7 @@ puts person
 # => {name: 'Fester'}
 ``` 
 
-### Show me the money
+#### Show me the money
 *Thyng objects are subclassed from ruby hashes. This means most database orm's know exactly how handle them*
 
 ```ruby
@@ -37,6 +37,8 @@ class Person < Thyng
 end
 
 class Credentials < Thyng
+  extend Thyng::CryptedAspect
+
   aspect_accessor :email
   crypted_accessor :password # <- Oooh!
 end
@@ -70,11 +72,49 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Plain aspects
+*See introduction Example*
+
+#### Crypted aspects
+To use this you must first add the module to thyng or your subclass of thyng. This will add the `crypted_accessor` method to your class.
+
+`crypted_accessor` takes an aspect and adds five methods to you class. These are reader and writer methods for both the Bcrypt object and raw crypted string, as well as a check_aspect method
+
+**Example**
+```ruby
+class Credentials < Thyng
+  extend Thyng::CryptedAspect
+
+  aspect_accessor :email
+  crypted_accessor :password
+end
+
+credentials = Credentials.new email: 'test@example.com', password: 'password'
+# => {:email=>"test@example.com", "crypted_password"=>"$2a$10$Bw4qH9Hp3iMG7c97SIBgJ.ahpXbL8M95FyDU7O.UHo4zgnxcm3bBi"} 
+
+credentials.password.class
+# => BCrypt::Password 
+
+credentials.crypted_password.class
+# => BCrypt::Password 
+
+credentials.check_password? 'password'
+# => true 
+
+password_hash = BCrypt::Password.create('secret')
+# => "$2a$10$O5DChGjqYxAU7yxo/J9.7uK55XPeWQxP0hU7nPYQNE85yDbl3H3I6" 
+
+credentials.crypted_password = password_hash
+# => "$2a$10$O5DChGjqYxAU7yxo/J9.7uK55XPeWQxP0hU7nPYQNE85yDbl3H3I6" 
+
+credentials.check_password? 'secret'
+# => true 
+
+``` 
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/thyng/fork )
+1. Fork it ( https://github.com/CrowdHailer/thyng/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`)

data/lib/thyng.rb

@@ -1,4 +1,5 @@
 require "thyng/version"
+require "thyng/crypted_aspect"
 
 class Thyng < Hash
   def initialize(args={})

data/lib/thyng/crypted_aspect.rb

@@ -0,0 +1,22 @@
+require 'bcrypt'
+
+class Thyng < Hash
+  module CryptedAspect
+    def crypted_accessor(aspect)
+      crypted_aspect = "crypted_#{aspect}"
+      aspect_accessor crypted_aspect
+
+      define_method "#{aspect}=", ->(value) {
+        send "#{crypted_aspect}=", BCrypt::Password.create(value)
+      }
+
+      define_method aspect, -> () {
+        BCrypt::Password.new send(crypted_aspect)
+      }
+
+      define_method "check_#{aspect}?", -> (test_value) {
+        send(aspect) == test_value
+      }
+    end
+  end
+end

data/lib/thyng/version.rb

@@ -1,3 +1,3 @@
 class Thyng < Hash
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/crypted/crypted_test.rb

@@ -0,0 +1,34 @@
+require_relative '../test_config'
+
+class CryptedTest < MiniTest::Test
+  def password
+    'password'
+  end
+
+  def crypted_example
+    Class.new Thyng do
+      extend Thyng::CryptedAspect
+      crypted_accessor :password
+    end
+  end
+
+  def test_creates_writer_to_crypted_value
+    example = crypted_example.new
+    assert example.respond_to?('crypted_password='), 'Should be able to write crypted value'
+  end
+
+  def test_creates_reader_to_crypted_value
+    example = crypted_example.new
+    assert example.respond_to?('crypted_password'), 'Should be able to read crypted value'
+  end
+
+  def test_aspect_is_saved_encrypted
+    example = crypted_example.new password: password
+    assert_equal BCrypt::Password, example.password.class
+  end
+
+  def test_can_check_against_encrypted_value
+    example = crypted_example.new password: password
+    assert_equal true, example.check_password?(password)
+  end
+end

data/test/test_config.rb

@@ -1,2 +1,8 @@
 require 'thyng'
-require 'minitest/autorun'
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+reporter_options = {color: true, slow_count: 5}
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(reporter_options)]
+
+BCrypt::Engine.cost = 1

data/thyng.gemspec

@@ -10,21 +10,10 @@ Gem::Specification.new do |spec|
   spec.email         = ["peterhsaxton@gmail.com"]
   spec.summary       = %q{Ruby objects with public state to encourage storage as data only collections}
   spec.description   = %q{
-    Thyng
-    
-    Ruby objects with public state to encourage storage as data only collections.
-
-    What?
-
-    A thyng is a ruby object with the convention of saving state in key:value pairs that are public on the object rather than in private instance variables.
-
-    How?
-
+    Create Ruby objects with public state to encourage their storage as data only collections.
     Instead of private attributes a thyng has public aspects. Basic access to these can be declared with asect_reader, aspect_write & aspect_accessor.
-
-    Why?
-
-    Will all internal state a thyng can be reconstructed completly from its data. This allows it to be passed as JSON a json object and easily be stored in a database.
+    Thyng is a subclass of a plain Ruby Hash allowing merging, filtering etc of the objects aspects.
+    With all state external a thyng can be reconstructed completly from its data. This allows it to be passed as JSON or easily stored in a database.
   }
   spec.homepage      = "https://github.com/CrowdHailer/Thyng"
   spec.license       = "MIT"
@@ -37,4 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.4.3"
+  spec.add_development_dependency "minitest-reporters", "~> 1.0.6"
+
+  spec.add_dependency "bcrypt", "~> 3.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thyng
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Peter Saxton
@@ -52,14 +52,41 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.4.3
-description: "\n    Thyng\n    \n    Ruby objects with public state to encourage storage
-  as data only collections.\n\n    What?\n\n    A thyng is a ruby object with the
-  convention of saving state in key:value pairs that are public on the object rather
-  than in private instance variables.\n\n    How?\n\n    Instead of private attributes
-  a thyng has public aspects. Basic access to these can be declared with asect_reader,
-  aspect_write & aspect_accessor.\n\n    Why?\n\n    Will all internal state a thyng
-  can be reconstructed completly from its data. This allows it to be passed as JSON
-  a json object and easily be stored in a database.\n  "
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+description: "\n    Create Ruby objects with public state to encourage their storage
+  as data only collections.\n    Instead of private attributes a thyng has public
+  aspects. Basic access to these can be declared with asect_reader, aspect_write &
+  aspect_accessor.\n    Thyng is a subclass of a plain Ruby Hash allowing merging,
+  filtering etc of the objects aspects.\n    With all state external a thyng can be
+  reconstructed completly from its data. This allows it to be passed as JSON or easily
+  stored in a database.\n  "
 email:
 - peterhsaxton@gmail.com
 executables: []
@@ -72,12 +99,14 @@ files:
 - README.md
 - Rakefile
 - lib/thyng.rb
+- lib/thyng/crypted_aspect.rb
 - lib/thyng/version.rb
 - tasks/test.rake
 - test/core/accessor_test.rb
 - test/core/initializer_test.rb
 - test/core/reader_test.rb
 - test/core/writer_test.rb
+- test/crypted/crypted_test.rb
 - test/test_config.rb
 - test/version/version_test.rb
 - thyng.gemspec
@@ -110,5 +139,6 @@ test_files:
 - test/core/initializer_test.rb
 - test/core/reader_test.rb
 - test/core/writer_test.rb
+- test/crypted/crypted_test.rb
 - test/test_config.rb
 - test/version/version_test.rb