kinto_box 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5246de9ec861fb33f83486fe3f153dfbd184ced5
-  data.tar.gz: 6f594d8293751c6ce803a17b9107afbeffee5b2c
+  metadata.gz: f41cad2d2d36c3deaf4c1804af203d22dfa86a59
+  data.tar.gz: 19d61573448b09387cee1acd839c0e5be0f00565
 SHA512:
-  metadata.gz: fc70c5827672c871ca69367a27f4d11182ebf26c213c61da7a5eb92997ed2238ab8d5c6834de6aaa26bd671dbffdb4d2bbcc1a3ad7c074600cfe72bb84755447
-  data.tar.gz: 44b7608328143c88c9671209f3a476622b784fc04f35d83ec6ea27e8ea9346a0a8ccd1394d71b97472a0f8232da2e3084bebcf02c76ec5a03632f2425b5833cb
+  metadata.gz: 48009280a182692c987a599f913847a2b96539d9394595bed282c6e01ed03f8136935f48155783b18c9beac23d06aac25e7f1b3e2fbdcc0233358b4364570481
+  data.tar.gz: dfc240b5ac5970a1c1bcce4368b6f9f8930f9171fe36df89787918dcf8e2f04d69442ccf892b958ece98fa55e3ab8987e84db81d4d22d74d52002568f09b470a

data/README.md

@@ -19,8 +19,197 @@ Or install it yourself as:
     $ gem install kinto_box
 
 ## Usage
+To use kinto_box, add `require 'kinto_box'` to your file.
 
-TODO: Write usage instructions here
+
+### Connection and Authentication
+
+
+To connect to a kinto server, you can pass the username and password to the client
+
+```
+kinto_client = KintoBox::KintoClient.new('https://kinto.dev.mozaws.net', {:username => 'token', :password => 'my-secret'})
+```
+
+If no credentials are passed, the gem looks for `KINTO_API_TOKEN` environment variable. The environment variable should store the Base64 encoding of `username:password` string, for this to work.
+
+
+### Buckets
+
+#### Creating a new bucket
+
+To create a new bucket named `TestBucket`
+
+```
+bucket = kinto_client.create_bucket('TestBucket')
+```
+
+#### Using a bucket
+
+To connect to a bucket named `TestBucket`
+
+```
+bucket = kinto_client.bucket('TestBucket')
+```
+
+> Note: This does not create the bucket nor check if the bucket exists on the server.
+
+To check if the bucket exists use
+
+```
+bucket.exists?
+```
+
+To get information about the bucket, use
+
+```
+bucket.info
+```
+
+#### Bucket permissions
+
+To get permissions set on the bucket, use
+
+```
+bucket.permissions
+```
+
+To add permission to the bucket, use `add_permission(principal, permission)`
+
+See `http://kinto.readthedocs.io/en/stable/api/1.x/permissions.html#api-permissions` to see valid principals and permissions
+
+For convenience, the following are supported. `everyone` and `anonymous` is the same as `System.Everyone`. And `authenticated` is the same as `System.Authenticated`
+
+#### Deleting bucket
+To delete a bucket, use
+
+```
+bucket.delete
+```
+
+### Collections
+
+#### Creating a collection
+
+To create a collection named `TestCollection`, use
+
+```
+collection = bucket.create_collection('TestCollection')
+```
+
+#### Using a collection
+
+To connect to a collection named `TestCollection`
+
+```
+collection = bucket.collection('TestCollection')
+```
+
+> Note: This does not create the collectiont nor check if the collection exists on the server.
+
+To check if the collection exists use
+
+```
+collection.exists?
+```
+
+To get information about the bucket, use
+
+```
+collection.info
+```
+
+#### Collection permissions
+
+To get permissions set on the collection, use
+
+```
+collection.permissions
+```
+
+To add permission to the bucket, use `collection.add_permission(principal, permission)`
+
+
+#### Deleting a collection
+To delete a bucket, use
+
+```
+collection.delete
+```
+
+To read from the collection
+
+```
+records = collection.list_records
+```
+
+To delete all records from the collection
+
+```
+records = collection.delete_records
+```
+
+### Records
+
+To add an object to the collection
+
+```
+data = { 'foo' => 'value1' }
+collection.create_record(data)
+```
+
+#### Deleting a record
+```
+record.delete
+```
+
+#### Update data in a record
+
+```
+record.update({'bar' => new_value})
+```
+
+This add a value bar to the record
+
+To replace the data entirely, use
+
+```
+record.replace({'bar' => new_value})
+```
+
+This drops the property food taht existed before the update.
+
+
+### Groups
+
+#### Creatinga group
+
+```
+    group = bucket.create_group(group_name, member)
+```
+
+Member can be any valid principal
+
+
+#### Deleting a group
+```
+    group.delete
+```
+
+#### Manging members
+
+```
+group.add_member(user)
+group.remove_member(user)
+```
+
+To replace all members, use
+
+```
+group.update_members(users)
+```
+
+See `test/kinto_box_test` for more usages
 
 ## Development
 

data/lib/kinto_box/kinto_group.rb

@@ -31,9 +31,5 @@ module KintoBox
       members.delete(member)
       update({ 'members' => members })
     end
-
-    def delete_records
-      @kinto_client.delete("#{@url_path}/records")
-    end
   end
 end

data/lib/kinto_box/kinto_object.rb

@@ -22,12 +22,12 @@ module KintoBox
     end
 
     def add_permission(principal, permission)
-      @kinto_client.patch(@url_path, {'permissions' => { permission_name(permission) => [principal_name(principal)] }})
+      @kinto_client.patch(@url_path, {'permissions' => { permission => [principal_name(principal)] }})
       return self
     end
 
     def replace_permission(principal, permission)
-      @kinto_client.put(@url_path, {'permissions' => { permission_name(permission) => [principal_name(principal)] }})
+      @kinto_client.put(@url_path, {'permissions' => { permission => [principal_name(principal)] }})
       return self
     end
 
@@ -37,22 +37,6 @@ module KintoBox
 
     private
 
-    def permission_name(permission)
-      case permission.downcase
-        when 'read'
-          return 'read'
-        when 'write'
-          return 'write'
-        when 'create'
-          return 'collection:create' if self.kind_of? KintoBucket
-          return 'record:create' if self.kind_of? KintoCollection
-        when 'group:create'
-          return 'group:create'
-        else
-          raise Exception 'not a valid permission'
-      end
-    end
-
     def principal_name(principal)
       case principal.downcase
         when 'authenticated'

data/lib/kinto_box/version.rb

@@ -1,3 +1,3 @@
 module KintoBox
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinto_box
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Kavya Sukumar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty