quickbase_record 0.4.2 → 0.4.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjQxYzVlNzkwN2NhMTQ4NWZlN2MzODQwOWU1NzI2MTQ0ZTMyN2YxYg==
+    NTQ2NTM5YWQxZTkwNDhiODdjODk5YTBjNTBmNmUxN2JmNzUyYzk1ZA==
   data.tar.gz: !binary |-
-    ZmNiZmQ4ZDY0MzZmYWU2ZTY3MWE4MGM5Y2U2ODkxNmRhYzFjMjA0Zg==
+    ZjA2MmViOGQ1OWU5ZDBmZDI5YWUxNTU3ZDU0YWY3YWYwMTc0ZjExNA==
 SHA512:
   metadata.gz: !binary |-
-    MTIyMWZkOTk2OGI4ZWZiOGMwNzE3NGY4OGY2MTBlNjVmNzlmZjkwYTE1OWM4
-    OTFmMzIyNDBkYjYxZjczODY1NTk3MGFlMWE3NTZlZmQwOWFhYTAwMmM0ODUy
-    MmNjZTBjZjlkZjkxN2I5MTBjNjhhYmQxM2E5NDM3MDMzMWQ5ZTY=
+    NTE2MjU2NDNiNDU0ODVhMGEzYWNjMDBiYjE1M2QxZjk4MTExYTVmMWI5YzI0
+    NzE2ZTYwMzYxYWZhNDg1ZjBjZWI4OWRhYTE2MjcwZWMwZTFkODFhZWNkNzNj
+    ZGVlMWRjODQxY2ZkNTM3MTYxNTVlMWViZWZlNjRlZTVhNjRkMDk=
   data.tar.gz: !binary |-
-    YjM1NGQ0ZjI5NDM2MWEzNzJmMjhmMWU2YzE4NTJlNzQ0NDdlNjQ2NmIzMTcy
-    MWJkOWQ1NGU1MTYyNzg2YmY3Y2JjYzA2NWE4YzNlOWZiMTk1ZmExNWUyZDhl
-    MTJmM2U0MTM0YzU4NjZiZGYwYjUzMjc2OWFhODVlN2ViZTM0Y2M=
+    NDA5ZDEyMGRlMjE5MDVmNzk3OTZhOWI3N2YwNjVjZDNmODg5OGNjODRmNDIx
+    OGMxODg3ZTM0MWEwOTA0NjNjM2JjYmY0NTk2YzQ2YTg2NGI5NWU0NWVhMGVj
+    YWMwYzM0YzhkOTZjNzlhYzVjOTJlYjEyMGYyY2M0ZjU1ODg1NzQ=

data/README.md

@@ -103,6 +103,14 @@ Post.build_query(author: 'Cullen', title: 'Some Title')
 => "{'8'.EX.'Cullen'}AND{'9'.EX.'Some Title'}"
 ```
 
+You can also access the underlying instance of the AdvantageQuickbase client with .qb_client. This property lives on both the class and on any instance of that class. To access the dbid for the table, call .dbid on the class.
+
+```
+  Post.qb_client.do_query(...)
+  @post = Post.new(...)
+  @post.qb_client.edit_record(self.class.dbid, self.id, {5 => 'Something', 6 => 'Something else'})
+```
+
 ## Available Methods
   * **.create(attributes_hash)**
     - Intantiate *and* save a new object with the given attributes
@@ -129,7 +137,7 @@ Post.build_query(author: 'Cullen', title: 'Some Title')
       Post.find(params[:id])
     ```
 
-  * **.where(attributes_hash)**
+  * **.where(attributes_hash OR string)**
     - Query QuickBase by any field name defined in your class' field mapping
     - Returns an array of objects
     ```
@@ -160,7 +168,7 @@ Post.build_query(author: 'Cullen', title: 'Some Title')
     - Combine arrays and hashes to build more complex queries
     ```
       Post.where(id: [{XEX: 123}, {OBF: 'today'}])
-      # "{'3'.XEX.'123'}OR{'3'.OAF.'today'}"
+      # "{'3'.XEX.'123'}OR{'3'.OBF.'today'}"
 
       Post.where(id: {XEX: 123, OAF: 'today'})
       # "{'3'.XEX.'123'}AND{'3'.OAF.'today'}"
@@ -173,9 +181,9 @@ Post.build_query(author: 'Cullen', title: 'Some Title')
       Post.where("{author.XEX.'Cullen Jett'}")
     ```
 
-    - To query using the QuickBase query options such as 'clist', 'slist', or 'options', include :query_options as a hash of option_property: value
+    * **Query Options (clist, slist, options)** To query using the QuickBase query options such as 'clist', 'slist', or 'options', include :query_options as a hash of option_property: value
     ```
-      Post.where(author: ['Cullen Jett', 'Socrates'], query_options: {clist: 'id.author', slist: 'author'})
+      Post.where(author: ['Cullen Jett', 'Socrates'], query_options: {clist: 'id.author', slist: 'author', options: 'num-1'})
     ```
 
   * **.batch_where(attributes_hash, count=1000)**
@@ -210,6 +218,18 @@ Post.build_query(author: 'Cullen', title: 'Some Title')
       @post.delete
     ```
 
+  * **.purge_records(attributes_hash OR QID)**
+    - Delete ALL records that match the attributes hash or are in the record corresponding to the QID argument
+    - Returns an array of deleted rids
+    - **CAUTION** If you do not supply a query parameter, this call will delete ALL of the records in the table.
+    ```
+      Post.purge_records(name: 'Cullen Jett') # attributes hash
+      or
+      Post.purge_records(9) # QID
+
+      => [1,2,3,4,5...]
+    ```
+
   * **#update_attributes(attributes_hash)**
     - **IMPORTANT: Updates *and* saves the object with the new attributes**
     - Only sends the passed in attributes as arguments to API_AddRecord or API_EditRecord (depending on whether the object has an ID or not)

data/lib/quickbase_record/queries.rb

@@ -85,6 +85,17 @@ module QuickbaseRecord
         all_query_results.flatten
       end
 
+      def purge_records(query_hash)
+        query = {}
+        if query_hash.is_a? Numeric
+          query[:qid] = query_hash
+        else
+          query[:query] = build_query(query_hash)
+        end
+
+        query_response = qb_client.purge_records(dbid, query)
+      end
+
       def build_quickbase_request(object)
         converted_object = {}
         fields.each do |field_name, field|

data/lib/quickbase_record/version.rb

@@ -1,3 +1,3 @@
 module QuickbaseRecord
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/spec/queries_spec.rb

@@ -97,6 +97,21 @@ RSpec.describe QuickbaseRecord::Queries do
     end
   end
 
+  describe '.purge_records' do
+    it "deletes all matching query records" do
+      teacher1 = TeacherFake.create(name: 'I should be deleted')
+      TeacherFake.purge_records(name: teacher1.name)
+      expect(TeacherFake.find(teacher1.id)).to be_nil
+    end
+
+    it "accepts a QID" do
+      teacher1 = TeacherFake.create(name: 'Purge McSplurge')
+      expect(TeacherFake.qid(5).length).to eq(1)
+      TeacherFake.purge_records(5)
+      expect(TeacherFake.qid(5)).to eq([])
+    end
+  end
+
   describe '#save' do
     it "doesn't save :read_only fields" do
       classroom = ClassroomFake.find(101)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickbase_record
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Cullen Jett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler