kinto_box 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f41cad2d2d36c3deaf4c1804af203d22dfa86a59
-  data.tar.gz: 19d61573448b09387cee1acd839c0e5be0f00565
+  metadata.gz: cd63b799d4e03bcc37de77e6e9669c29ca7f403e
+  data.tar.gz: e24e02470648c46c9b45ed357df0cff3e19f243b
 SHA512:
-  metadata.gz: 48009280a182692c987a599f913847a2b96539d9394595bed282c6e01ed03f8136935f48155783b18c9beac23d06aac25e7f1b3e2fbdcc0233358b4364570481
-  data.tar.gz: dfc240b5ac5970a1c1bcce4368b6f9f8930f9171fe36df89787918dcf8e2f04d69442ccf892b958ece98fa55e3ab8987e84db81d4d22d74d52002568f09b470a
+  metadata.gz: 300f47c897217f481d07ba653a1065693af058545b6c3b2fe27ccea491ab044a8c576b1b0f6518385d33e45fdf03fe801e54a00f6ce659fb61f675a78ce44760
+  data.tar.gz: 1f1b80c4135e17c9da8c81ead68ebcd593952159331dc4713ca4a3fce2036df92c668b367317d8e3f7c576a2e14b037afde2c0f4b1f53a41b9862dfd4c9baf08

data/README.md

@@ -28,7 +28,7 @@ To use kinto_box, add `require 'kinto_box'` to your file.
 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'})
+kinto_client = KintoBox.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.
@@ -105,7 +105,7 @@ 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.
+> Note: This does not create the collection nor check if the collection exists on the server.
 
 To check if the collection exists use
 
@@ -143,6 +143,14 @@ To read from the collection
 records = collection.list_records
 ```
 
+List records support filtering and sorting. It follows the convention described [here](http://kinto.readthedocs.io/en/stable/api/1.x/filtering.html) and [here](http://kinto.readthedocs.io/en/stable/api/1.x/sorting.html).
+
+```
+records = collection.list_records('min_val=10','val')
+```
+
+The above line will return all records where `val` is at least 10 and sorted ascending on the field `val`
+
 To delete all records from the collection
 
 ```

data/lib/kinto_box/kinto_collection.rb

@@ -22,8 +22,13 @@ module KintoBox
       record.info
     end
 
-    def list_records
-      @kinto_client.get("#{@url_path}/records")
+    def list_records(filters = nil, sort = nil)
+      query_string = '?'
+      query_string += filters unless filters.nil?
+      query_string += '&' unless filters.nil? || sort.nil?
+      query_string += "_sort=#{sort}" unless sort.nil?
+      path = query_string == '?' ? "#{@url_path}/records" : "#{@url_path}/records#{query_string}"
+      @kinto_client.get(path)
     end
 
     def create_record(data)

data/lib/kinto_box/version.rb

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

data/lib/kinto_box.rb

@@ -5,11 +5,28 @@ require 'kinto_box/kinto_bucket'
 require 'base64'
 
 module KintoBox
+
+  # Initializes a new Kinto client.
+  #
+  # @param [String] server Url of the server without the version
+  # @param [Hash] options Optional parameter. If the hash contains :username and :password, it will be used to authenticate.
+  # `options` parameter can be used to pass in credentials. If no credentials are passed, it looks for KINTO_API_TOKEN environment variable
+  # @return [KintoBox::KintoClient] A kinto client object
+  def KintoBox.new(server, options = nil)
+    return KintoClient.new(server, options)
+  end
+
   class KintoClient
     include HTTParty
     headers 'Accept' => 'application/json', 'Content-Type' => 'application/json'
     format :json
 
+    # Initializes a new Kinto client.
+    #
+    # @param [String] server Url of the server without the version
+    # @param [Hash] options Optional parameter. If the hash contains :username and :password, it will be used to authenticate.
+    # `options` parameter can be used to pass in credentials. If no credentials are passed, it looks for KINTO_API_TOKEN environment variable
+    # @return [KintoBox::KintoClient] A kinto client object
     def initialize(server, options = nil)
       @server = server
       self.class.base_uri URI.join(@server, '/v1/').to_s
@@ -22,49 +39,92 @@ module KintoBox
       self.class.headers('Authorization' => "Basic #{@auth}")
     end
 
+    # Get reference to a bucket
+    #
+    # @param [String] bucket_id The id of the bucket
+    # @return [KintoBox::KintoBucket] A kinto bucket object
     def bucket (bucket_id)
       @bucket = KintoBucket.new(self, bucket_id)
       @bucket
     end
 
+    # Get server information
+    #
+    # @return [Hash] Server info as a hash
     def server_info
       get '/'
     end
 
+    # Get current user id
+    #
+    # @return [String] current user id
     def current_user_id
       server_info['user']['id']
     end
 
-    # buckets
+    # List of buckets
+    #
+    # @return [Hash] with list of buckets
     def list_buckets
       get '/buckets'
     end
 
+    # Create a bucket
+    #
+    # @param [String] bucket_id The id of the bucket
+    # @return [KintoBox::KintoBucket] A kinto bucket object
     def create_bucket(bucket_id)
       put "/buckets/#{bucket_id}"
       bucket(bucket_id)
     end
 
+    # Delete all buckets
+    #
     def delete_buckets
       delete '/buckets'
     end
 
+    # Calls http PUT on path
+    #
+    # @params [String]path Url path
+    # @params [Hash] data to be sent in the body
+    # @return [Hash] response body
     def put(path, data = {})
       ResponseHandler.handle self.class.put(path, :body => data.to_json)
     end
 
+    # Calls http POST on path
+    #
+    # @params [String]path Url path
+    # @params [Hash] data to be sent in the body
+    # @return [Hash] response body
     def post(path, data = {})
       ResponseHandler.handle self.class.post(path, :body => data.to_json)
     end
 
+    # Calls http PATCH on path
+    #
+    # @params [String]path Url path
+    # @params [Hash] data to be sent in the body
+    # @return [Hash] response body
     def patch(path, data)
       ResponseHandler.handle self.class.patch(path, :body => data.to_json)
     end
 
+    # Calls http DELETE on path
+    #
+    # @params [String]path Url path
+    # @params [Hash] data to be sent in the body
+    # @return [Hash] response body
     def delete(path)
       ResponseHandler.handle self.class.delete(path)
     end
 
+    # Calls http GET on path
+    #
+    # @params [String]path Url path
+    # @params [Hash] data to be sent in the body
+    # @return [Hash] response body
     def get(path)
       ResponseHandler.handle self.class.get(path)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kinto_box
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Kavya Sukumar