quickbase_record 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODYyYTFkNjQ2ZWJlY2MyYmM4ZTIzMjMxZGIwZGQ0NmIxYmM2ZTk3OA==
+    ZWUzNzIwNjc3YjY3NjllMjcyODVmZWIyYzFjNWNjY2MxZjc2Zjg4NA==
   data.tar.gz: !binary |-
-    ODM0YjlmNmM0ZWY2ODZlODhkZGYwNjRjYjAyZDlkOWNkZDZmYjU5Yw==
+    OTQ4MmNiNzE3M2JlNzRhYTFmN2Q0MmU3YmJhODE4YjBjNzFmYTg3Nw==
 SHA512:
   metadata.gz: !binary |-
-    ZWM1MTQ2OGQ0ZjIyMDFjM2U1MjhjNmEzZDBhZWZmZWM1M2VjMGQyMjgxZDFl
-    ZjI1M2FjNjZjODFmNDU3Yjg1ZTNkN2Y1ZWM5Yzc2ODlhOWQ0NjQ2ZTYyNGUw
-    OTRhYTA0ZTY1MjVhMTIxYWQ1MTQxMzUyMWNiMjUyMWYzYjdjN2E=
+    NDdiYmEwMjZmYWFmOWQzNTNjYWY2ZjU2ZDQyYWNhMTM3N2JmMTQwYjQwYWQ3
+    M2I4NTNiYjhjYjE5NjM2M2NjN2FkY2U2NjUyNzk5ZmQ1ZjY5NDQyYWEyN2Nk
+    ODJhYmUyZWJkYzhkN2U2MGE3OWU1MzUzYTdjZDYyZWZhODlkYjQ=
   data.tar.gz: !binary |-
-    ZDBkNjQzZmM0ZWViZTUwNjY0MWIzMDQ3MDgzOWFlYzViMDM2ZWU3NTgwZTI2
-    OWNmNDcxYmZmNmI3YmU3MTE3ODZmNDI2OTM4NDk1MTU3MDZkYWQ4ODMxNTk2
-    NTY0Y2JhMWFkN2U2NDAwODg2ZjdmYzFiNTNiNzU0NTFjMTUxMzQ=
+    Mzk2MDkzNWJjZmUxOGJiNDNlYWEwZTczYWQ3MmQwMjNiNDk1YzdjODBlNmJh
+    NmEyMTY0MzU0ZDUwMDQ4NjIxNzRjMDIwZjJhYzhiZjYxYWI2N2E1ODA5ZWMz
+    OWUwMjIwOWFiNmM0Nzg0MzgwZTU3OTg2MzM1OGFmZDgwNTQwZDg=

data/README.md

@@ -30,6 +30,7 @@ QuickbaseRecord is built on top of the [Advantage Quickbase](https://github.com/
     config.realm = "your_apps_realm_name"
     config.username = "valid_username" (or something like ENV["QB_USERNAME"])
     config.password = "valid_password" (or something like ENV["QB_PASSWORD"])
+    config.token = "your_app_token_if_applicable"
   end
 ```
 
@@ -37,9 +38,9 @@ QuickbaseRecord is built on top of the [Advantage Quickbase](https://github.com/
 Simply `include QuickbaseRecord::Model` in your class and use the `.define_fields` method to supply the table's DBID and a mapping of desired field names => QuickBase FIDs
 
 ```
-  # app/models/posts.rb
+  # app/models/post.rb
 
-  class Posts
+  class Post
     include QuickbaseRecord::Model
 
     define_fields ({
@@ -58,7 +59,7 @@ Simply `include QuickbaseRecord::Model` in your class and use the `.define_field
 Classes that include QuickbaseRecord::Model and define their fields will have a handful of class and instance methods for interacting with your QuickBase application similar to ActiveRecord. The goal is to be able to use QuickBase as a database and treat your models the same way you would with a traditional database.
 
 ```
-@post = Posts.find(1) => <Post: @id=1, @content="Amazing post content", @author: 'Cullen Jett'>
+@post = Post.find(1) => <Post: @id=1, @content="Amazing post content", @author: 'Cullen Jett'>
 
 --
 
@@ -88,38 +89,38 @@ Database callbacks (i.e. `before_save :create_token!`) are not fully functional
     - Intantiate *and* save a new object with the given attributes
     - Assigns the returned object it's new ID
     ```
-      Posts.create(content: 'Amazing post content', author: 'Cullen Jett')
+      Post.create(content: 'Amazing post content', author: 'Cullen Jett')
     ```
 
   * **.find(id)**
     - Query for a specific QuickBase record by it's ID
     - Returns a single object
     ```
-      Posts.find(params[:id])
+      Post.find(params[:id])
     ```
 
   * **.where(attributes_hash)**
     - Query QuickBase by any field name defined in your class' field mapping
     - Returns an array of objects
     ```
-      Posts.where(author: 'Cullen Jett').first
+      Post.where(author: 'Cullen Jett').first
     ```
 
     - Multiple field_name/value pairs are joined with 'AND'
     ```
-      Posts.where(id: 1, author: 'Cullen Jett')
+      Post.where(id: 1, author: 'Cullen Jett')
       # {'3'.EX.'1'}AND{'8'.EX.'Cullen Jett'}
     ```
 
     - Values in an array are joined with 'OR'
     ```
-      Posts.where(author: ['Cullen Jett', 'Socrates')
+      Post.where(author: ['Cullen Jett', 'Socrates')
       # {'8'.EX.'Socrates'}OR{'8'.EX.'Socrates'}
     ```
 
     - To use a comparitor other than 'EX' pass the value as another hash with the key as the comparitor
     ```
-      Posts.where(author: {XEX: 'Cullen Jett'})
+      Post.where(author: {XEX: 'Cullen Jett'})
       # {'8'.XEX.'Cullen Jett'}
     ```
 
@@ -128,15 +129,15 @@ Database callbacks (i.e. `before_save :create_token!`) are not fully functional
     - Returns an array of objects
     - Works with field names or FIDs
     ```
-      Posts.query("{'3'.EX.'1'}")
-      Posts.query("{author.XEX.'Cullen Jett'}")
+      Post.query("{'3'.EX.'1'}")
+      Post.query("{author.XEX.'Cullen Jett'}")
     ```
 
   * **.qid(id)**
     - Accepts a QID (QuickBase report ID)
     - Returns an array of objects
     ```
-      Posts.qid(1)
+      Post.qid(1)
     ```
 
   * **#save**
@@ -144,7 +145,7 @@ Database callbacks (i.e. `before_save :create_token!`) are not fully functional
     - Returns the object (if #save created a record in QuickBase the the returned object will now have an ID)
     - Uses API_ImportFromCSV under the hood.
     ```
-      @post = Posts.new(content: 'Amazing post content', author: 'Cullen Jett')
+      @post = Post.new(content: 'Amazing post content', author: 'Cullen Jett')
       @post.save # => <Post: @id: 1, @content: 'Amazing post content', @author: 'Cullen Jett'
 
       @post.author = 'Socrates'
@@ -160,10 +161,10 @@ Database callbacks (i.e. `before_save :create_token!`) are not fully functional
     ```
 
   * **#update_attributes(attributes_hash)**
-    - Updates *and* saves the object with the new attributes
+    - ** IMPORTANT: Updates *and* saves the object with the new attributes**
     - Returns the object
     ```
-      @post = Posts.where(author: 'Cullen Jett').first
+      @post = Post.where(author: 'Cullen Jett').first
       @post.update_attributes(author: 'Socrates', content: 'Something enlightening...') # => <Post: @id: 1, @author: 'Socrates', @content: 'Something enlightening...'
     ```
 
@@ -172,7 +173,7 @@ Database callbacks (i.e. `before_save :create_token!`) are not fully functional
     - Useful for assigning multiple attributes at once, otherwise you could use the field name's attr_accessor to change a single attribute.
     - Returns the object
     ```
-      @post = Posts.where(author: 'Cullen Jett').first
+      @post = Post.where(author: 'Cullen Jett').first
       @post.assign_attributes(author: 'Socrates', content: 'Something enlightening...')
       @post.save
     ```

data/lib/quickbase_record/queries.rb

@@ -20,7 +20,7 @@ module QuickbaseRecord
         query_options = { query: build_query(id: id), clist: clist }
         query_response = qb_client.do_query(dbid, query_options).first
 
-        return false if query_response.nil?
+        return nil if query_response.nil?
 
         converted_response = convert_quickbase_response(query_response)
         new(converted_response)
@@ -30,7 +30,7 @@ module QuickbaseRecord
         query_options = { query: build_query(query_hash), clist: clist }
         query_response = qb_client.do_query(dbid, query_options)
 
-        return false if query_response.first.nil?
+        return [] if query_response.first.nil?
 
         build_array_of_new_objects(query_response)
       end
@@ -46,6 +46,8 @@ module QuickbaseRecord
         query_options = { qid: id, clist: clist }
         query_response = qb_client.do_query(dbid, query_options)
 
+        return [] if query_response.first.nil?
+
         build_array_of_new_objects(query_response)
       end
 

data/lib/quickbase_record/version.rb

@@ -1,3 +1,3 @@
 module QuickbaseRecord
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/queries_spec.rb

@@ -12,9 +12,9 @@ RSpec.describe QuickbaseRecord::Queries do
       expect(teacher).to be_a TeacherFake
     end
 
-    it "returns false if no QuickBase records are found" do
+    it "returns nil if no QuickBase records are found" do
       teacher = TeacherFake.find(999999)
-      expect(teacher).to be false
+      expect(teacher).to eq(nil)
     end
   end
 
@@ -39,9 +39,9 @@ RSpec.describe QuickbaseRecord::Queries do
       expect(teachers.first.id).to eq('1')
     end
 
-    it "returns false if no QuickBase records are found" do
+    it "returns an empty array if no QuickBase records are found" do
       teachers = TeacherFake.where(name: 'Not a real TeacherFake name...')
-      expect(teachers).to be false
+      expect(teachers).to eq([])
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickbase_record
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Cullen Jett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-12 00:00:00.000000000 Z
+date: 2015-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,7 +129,7 @@ files:
 - lib/quickbase_record/model.rb
 - lib/quickbase_record/queries.rb
 - lib/quickbase_record/version.rb
-- quickbase_record-0.0.2.gem
+- quickbase_record-0.1.0.gem
 - quickbase_record.gemspec
 - spec/fakes/student_fake.rb
 - spec/fakes/teacher_fake.rb