ozy 0.0.3 → 0.0.4

data/README.md

@@ -1,53 +1,76 @@
-Addressabler
+Ozymandias
 =
 
-**Addressabler** extends the Addressable::URI class by adding TLD parsing, domain and subdomain parsing, and query modification.
+**Ozy** is a simple Hash subclass that persists itself to Redis, if you'll let it. This provides a clean interface to storing data in Redis without calling all those crazy Redis commands. Of course, Ozy also supports those commands, so go nuts.
 
 Install
 ==
 
 Install using Rubygems:
 
-	gem install addressabler
+	gem install ozy
 
 Then:
 
 	require 'rubygems'
-	require 'addressabler'
-
-Addressabler will automatically require `addressable/uri`.
+	require 'ozy'
 
 Usage
 ==
 
-Use Addressable::URI like you normally would:
+Ozy's are just Hashes, but accept a hash for its initialization:
+
+	@ozy = Ozy.new(:foo => :bar)
+
+Persistence
+===
+
+An Ozy won't persist until you tell it to by calling "save" and passing it a key:
+
+	@ozy.save(:key)
+
+You can get an Ozy using that key:
+
+	Ozy.get(:key) #=> key: {:foo => :bar}
+
+Expiration
+===
+You can pass an options hash into an Ozy initializer as well. Currently, the only supported option is `expire`:
+
+	@ozy = Ozy.new({:foo => :bar}, :expire => 60)
+	@ozy.expires_in #=> 60
+
+Ozy's expiration times won't start ticking down until you save them. Cause they're not in Redis yet. Are you getting it?
 
-	@uri = Addressable::URI.parse("http://www.google.com/")
-	@uri.host #=> "www.google.com"
+	@ozy.save(:key)
+	sleep 1
+	@ozy.expires_in #=> 59
 
-Addressabler will add the following properties:
+You can extend an Ozy's expiration like so:
 
-	@uri.tld #=> "com"
-	@uri.domain #=> "google"
-	@uri.subdomain #=> "www"
+	@ozy.expire_in! 120
+	@ozy.expires_in #=> 120
 
-You can set these values, as well:
+Automatic Persistence
+===
+Changes made to a saved Ozy will automatically persist to Redis without calling save again:
 
-	@uri.tld = "org"
-	@uri.host #=> "www.google.org"
-	@uri.domain = "amazon"
-	@uri.host #=> "www.amazon.org"
-	@uri.subdomain = "developers"
-	@uri.host #=> "developers.amazon.org"
+	@ozy = Ozy.new(:foo => :bar)
+	@ozy.save(:key)
+	@ozy.merge!(:foo => :baz)
+	@ozy[:your] = :mom
+	Ozy.get(:key) #=> foo: {:foo => :baz, :your => :mom}
 
-Addressabler copies some of Paul Dix's [Domaintrix](https://github.com/pauldix/domainatrix) TLD code to support fancy TLDs, as well:
+If you want to skip the whole "save" thing, just call Ozy.create(key, attributes):
 
-	@uri.host = "www.google.co.uk"
-	@uri.tld #=> "co.uk"
+	@ozy = Ozy.create(:key, :i_will => :hunt_ed)
+	Ozy.get(:key) #=> key: {:i_will => :hunt_ed}
 
-Addressabler also makes editing queries a little bit easier:
+Redis Commands
+===
+Ozy's accept any key-based Redis command, as well. Example:
 
-	@uri.query_hash[:foo] = :bar
-	@uri.to_s #=> "http://www.google.co.uk/?foo=bar"
+	@ozy.del
+	Ozy.get(:key) #=> nil
 
-That's it. Enjoy.
+And... that's it!

data/lib/ozy.rb

@@ -58,6 +58,9 @@ class Ozy < ::Hash
 
   def initialize(attributes = {}, options = {})
     @options = options
+    if @options[:key]
+      @persisted = true
+    end
     merge! attributes unless attributes.empty?
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ozy
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Flip Sasser