general_store 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba8eedc02580250094988ac68b234dfc49200fda
-  data.tar.gz: c7baaed5d8665d33effc0671ad3dcfbf1d0a464e
+  metadata.gz: e0fcdc610162d8cfc8ce79887f9a6b7e5dfbbf91
+  data.tar.gz: 339c04790979665714fbf03160d46240d97e5959
 SHA512:
-  metadata.gz: a22a2a7d18fb72f9f0a76b8892cbc9082c113d4e928daf54a9e0709a0de4d6149f1937a8b745e2cc508b244e98b5015616c1c7bb44e28bce00b61e326d39e550
-  data.tar.gz: 809ee641aa6ef8da2157084faedb0e8304e656507e28f6bbdfc6c46a2c86200a8495281d856306ac8c779d29359062a3db5e5c95ec5c13e220a83b165878e3ad
+  metadata.gz: 8df4f776ab2f006532a6d50eb183756fdf975edacfd52ee40cacb47470e55de89ec74622842c10474e8c18c76eda3f49933034e30de2f958904ee13903c57e8b
+  data.tar.gz: 6b0441024dd5cec88771137b8e8da5645626e590cbd92b2b399133e744469e93a80b7566a446a453f7e5cc03344aafc8b70529c808015a38f497353e7b325a5d

data/README.md

@@ -1,6 +1,7 @@
 # GeneralStore
 
-TODO: Write a gem description
+General Store is an easy way to store user-specific credentials for an
+app on a user's machine.
 
 ## Installation
 
@@ -18,7 +19,41 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Set the directory you want your `config.yml` file saved in, and push in
+the values you want to store:
+
+``` ruby
+GeneralStore.create '~/.your_directory' do |gs|
+  gs.consumer_key = 'my key'
+  gs.consumer_secret = 'my secret'
+  gs.oauth_token = 'oauth token'
+  gs.oauth_token_secret = 'oauth token secret'
+end
+```
+
+And then access them:
+
+``` ruby
+store = GeneralStore.read '~/.your_directory'
+
+store.consumer_key
+=> 'my key'
+store.consumer_secret
+=> 'my secret'
+```
+
+Apply any arbitrary name to your attributes when going into your store;
+they will be accessible when you take them out:
+
+``` ruby
+GeneralStore.create '~/.some_other_dir' do |gs|
+  gs.SoMethIngCRAZY = 'I couldnt think of a good example'
+end
+
+store = GeneralStore.read '~/.some_other_dir'
+store.SoMethIngCRAZY
+=> 'I couldnt think of a good example'
+```
 
 ## Contributing
 

data/lib/general_store.rb

@@ -38,7 +38,8 @@ class GeneralStore
   end
 
   def set dir
-    File.write self.class.config_file(dir), YAML.dump(config)
+    klass = self.class
+    klass.write_file klass.config_file(dir), config
   end
 
   def self.create_config_file
@@ -46,6 +47,12 @@ class GeneralStore
     check_file_existence
   end
 
+  def self.write_file file, data
+    File.open file, File::RDWR|File::TRUNC|File::CREAT, 0600 do |config|
+      config.write YAML.dump data
+    end
+  end
+
   def self.check_dir_existence
     unless Dir.exists? config_dir
       Dir.mkdir config_dir
@@ -55,7 +62,7 @@ class GeneralStore
   def self.check_file_existence
     file = config_file @dir
     unless File.exists? file
-      File.write file, YAML.dump({})
+      write_file file, {}
     end
   end
 end

data/lib/general_store/version.rb

@@ -1,3 +1,3 @@
 module GeneralStore
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: general_store
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stuart Nelson