kooaba 0.0.1 → 0.0.2

data/README.md

@@ -17,24 +17,24 @@ This is a lightweight gem (no other dependencies) for accessing the [kooaba APIs
 
 ## Uploading an item
 
-In order to upload items into your account, you need an UPLOAD\_KEY and a BUCKET\_ID. Both of these you can find in your account at https://platform.kooaba.com .
+In order to upload items into your account, you need a `data-key` and a `bucket-id`. The `data-key` you can find on your account on the [kooaba platform](https://platform.kooaba.com), under API Access -> Data API Keys. You need to use the `secret-token` string. The bucket id you find under the Reference Items section.
 
     require 'rubygems'
     require 'kooaba'
 
-    # set the upload key
-    Kooaba.upload_key = <UPLOAD_KEY>
+    # set the data key
+    Kooaba.data_key = <data-key-secret-token>
 
     # initialize the item
     item = Kooaba::Item.new(
       :title => "A lake",
       :metadata => nil,
-      :image_files => <PATH_TO_IMAGE_ON_LOCAL_SYSTEM>,
+      :image_files => <path-to-image-on-local-filesystem>,
       :referenceId => "lake"
       )
 
     # select the bucket you want to put the item into
-    bucket_id = <BUCKET_ID>
+    bucket_id = <bucket-id>
 
     # upload the item
     response = Kooaba.upload(item, bucket_id)
@@ -52,16 +52,16 @@ The reponse will look like:
 
 ## Making a query
 
-To make a query you need a QUERY_KEY which you can find under the API Access section in your account at https://platform.kooaba.com .
+To make a query you need a `query-key` which you can find under the API Access -> Query API Keys section in your [kooaba account](https://platform.kooaba.com). You need to use the `secret-token` string.
 
     require 'rubygems'
     require 'kooaba'
 
     # set the query key
-    Kooaba.query_key = <QUERY_KEY>
+    Kooaba.query_key = <query-key-secret-token>
 
     # send the query to the kooaba servers
-    query = Kooaba::Query.new(:image_path => <PATH_TO_QUERY_IMAGE_ON_LOCAL_SYSTEM>)
+    query = Kooaba::Query.new(:image_path => <path-to-query-image-on-local-filesystem>)
     response = Kooaba.query(query)
 
     # inspect the result

data/examples/query.rb

@@ -1,10 +1,10 @@
 require File.join(File.dirname(__FILE__), "..", "lib", "kooaba.rb")
 
 # set the query key
-Kooaba.query_key = <QUERY_KEY>
+Kooaba.query_key = <query-key-secret-token>
 
 # send the query to the kooaba servers
-query = Kooaba::Query.new(:image_path => <PATH_TO_IMAGE>)
+query = Kooaba::Query.new(:image_path => <path-to-image>)
 response = Kooaba.query(query)
 
 # inspect the result

data/examples/upload.rb

@@ -1,13 +1,13 @@
 require File.join(File.dirname(__FILE__), "..", "lib", "kooaba.rb")
 
-# set the upload key
-Kooaba.upload_key = <UPLOAD_KEY>
+# set the data key
+Kooaba.data_key = <data-key-secret-token>
 
 # initialize the item
 item = Kooaba::Item.new(
   :title => "A lake",
   :metadata => nil,
-  :image_files => <PATH_TO_IMAGE>,
+  :image_files => <path-to-image-on-local-filesystem>,
   :referenceId => "lake"
   )
 

data/lib/kooaba/base.rb

@@ -2,16 +2,16 @@ module Kooaba
   QUERY_URL  = "https://query-api.kooaba.com/v4/"
   UPLOAD_URL = "https://upload-api.kooaba.com/api/v4/"
 
-  def self.upload_key=(upload_key)
-    @@upload_key = upload_key
+  def self.data_key=(data_key)
+    @@data_key = data_key
   end
 
   def self.query_key=(query_key)
     @@query_key = query_key
   end
 
-  def self.upload_key
-    @@upload_key
+  def self.data_key
+    @@data_key
   end
 
   def self.query_key

data/lib/kooaba/upload_request.rb

@@ -39,7 +39,7 @@ module Kooaba
       req.body = @message.body
       req['date'] = Time.new.httpdate
       req['content-type'] = @message.content_type
-      req['authorization'] = "Token #{Kooaba.upload_key}"
+      req['authorization'] = "Token #{Kooaba.data_key}"
 
       http.start { |h| h.request(req) }
     end

data/lib/kooaba/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kooaba
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Cristi Prodan