quickbase_record 0.2.3 → 0.2.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTFlNzllN2NmODI1M2U5OWFlMTQyZTliOGQ3YTdhMDExMTA4OGM2Zg==
+    NTBiNzE5ZDE5ZmE1NjNiZGNkZDIyNzhkMmNjOTY5NTkxNzYzM2M0Zg==
   data.tar.gz: !binary |-
-    YTA1NjViZjNjYWQyODZhYWY0YmVjNDU2OTc2YTVkODBkOTZjNWNkYQ==
+    NzEyMDE4ZjdmOTNiN2M0YWZhZjYwMjAyZjMyZmRmNTBjM2MxYThkZg==
 SHA512:
   metadata.gz: !binary |-
-    YzNkMDE4ZDdmZDllMjYxMDQ3N2ViNTYzM2ZmNDJjYjVkYzA2MTIxZDBlZjM2
-    NDM4NzIwZDk2OTVmNWYxMDRhZGFlNDUwNzI4Y2RhOTMyMDc4NzhkYWM5OGEy
-    NDUzZDA3YjlhMDc5MDgzMmVkNzVkMTFlNDRmZDQ4MDQyMDdjMzI=
+    MGY2MGU0YTNlNGZjNmU0OWFjNGE2MDJkYmVkZmY2ODFlYjI5NDhiZmMwNDk0
+    YzE1NmVmYmFkZDU3YWIwYjQyMzQ0OGZmZGY5MmQ4Mzk4Zjc0YTcyMzYxYzgy
+    YzJmZDg0ZmVhYWZiNjQ5MGZmZGNhMWJhNzUwZWE5YjVjZmQzMWE=
   data.tar.gz: !binary |-
-    NDVlYzNlYjhkMjU0NmIwMzMzNGUyOWU2YjI1Y2YzNTQzYmU0NjM0YjA3OTY3
-    ZDM2Mzc5ZjBlMTYxNGE2ZTc4NTlkZWYyODY3ZjhlNGQzMjQwNzZlYjRkNjVk
-    ZDU0YTVmNzA1ZTczNmEwY2FmMjI3YzAzZTA4ODEyZTFiN2ZmMjY=
+    YmUyZjJiM2M5YTU4N2NmNjI0ZDJhYTVkN2YwYzRiNzZjZTJiNDM3YWFlNmRk
+    YWY4MjNkMGFjMjMwMzU3MGRiNDQwNzkwZGNjMzc4YTFlMWU2NDA2MGY2NjJl
+    ZTQ0Zjc5OWQ3YTQ3ZWU0NDFmYmUzYjE2MGE0YWJjZWNiMGNlMjY=

data/.gitignore

@@ -12,5 +12,6 @@
 *.o
 *.a
 mkmf.log
-/spec/quickbase_record_config
+/spec/quickbase_record_config.rb
+/spec/config.yml
 .DS_Store

data/README.md

@@ -53,6 +53,7 @@ Simply `include QuickbaseRecord::Model` in your class and use the `.define_field
     # code...
   end
 ```
+
 **IMPORTANT:** You must supply a key/value pair for :dbid and :id (QuickbaseRecord uses :id instead of :record_id to look more like standard ActiveRecord models)
 
 ### What You Get
@@ -114,8 +115,11 @@ Database callbacks (i.e. `before_save :create_token!`) are not fully functional
 
     - Values in an array are joined with 'OR'
     ```
-      Post.where(author: ['Cullen Jett', 'Socrates')
-      # {'8'.EX.'Socrates'}OR{'8'.EX.'Socrates'}
+      Post.where(author: ['Cullen Jett', 'Socrates'])
+      # {'8'.EX.'Cullen Jett'}OR{'8'.EX.'Socrates'}
+
+      Post.where({ [author: 'Cullen Jett', id: 123] })
+      # {'8'.EX.'Cullen Jett'}OR{'3'.EX.'123'}
     ```
 
     - To use a comparator other than 'EX' pass the value as another hash with the key as the comparator
@@ -188,6 +192,15 @@ Database callbacks (i.e. `before_save :create_token!`) are not fully functional
   * **.qb_client and #qb_client**
     - Access the quickbase API client (advantage_quickbase gem) directly
 
+## File Attachments
+When ***creating*** an object with a field of type 'file attachment', you must assign it as hash with :name and :file as keys.
+After the object is ***saved*** that field will then become a new hash with :filename and :url as keys.
+```
+  @post = Post.new(attachment: {name: 'Test File Name', file: 'path/to/your/file OR file contents'})
+  @post.save
+  @post.attachment => {filename: 'Test File Name', url: 'https://realm.quickbase.com/up/abcdefg/Test%20File%20Name'}
+```
+
 ## Testing
 Unfortunately you will not be able to run the test suite unless you have access to the QuickBase application used as the test database *or* you create your own QuickBase app to test against that mimics the test fakes. Eventually the test calls will be stubbed out so anyone can test it, but I've got stuff to do -- pull requests are welcome :)
 

data/lib/quickbase_record/queries.rb

@@ -55,6 +55,13 @@ module QuickbaseRecord
         return convert_query_string(query_hash) if query_hash.is_a? String
 
         query_hash.map do |field_name, values|
+          if field_name.is_a? Hash
+            return field_name.map do |field_name, value|
+              fid = convert_field_name_to_fid(field_name)
+              join_with_or(fid, [value])
+            end.join('OR')
+          end
+
           fid = convert_field_name_to_fid(field_name)
           if values.is_a? Array
             join_with_or(fid, values)
@@ -146,9 +153,19 @@ module QuickbaseRecord
       current_object = {}
       self.class.fields.each do |field_name, fid|
         current_object[fid] = public_send(field_name) unless UNWRITABLE_FIELDS.include?(field_name.to_s)
+      end
+
+      if has_file_attachment?(current_object)
+        if self.id
+          qb_client.edit_record(self.class.dbid, self.id, current_object)
+        else
+          self.id = qb_client.add_record(self.class.dbid, current_object)
+        end
+      else
         current_object[self.class.fields[:id]] = self.id if self.id
+        self.id = qb_client.import_from_csv(self.class.dbid, [current_object]).first
       end
-      self.id = qb_client.import_from_csv(self.class.dbid, [current_object]).first
+
       return self
     end
 
@@ -164,5 +181,11 @@ module QuickbaseRecord
       self.save
       return self
     end
+
+    private
+
+    def has_file_attachment?(current_object)
+      current_object.values.any? { |value| value.is_a? Hash }
+    end
   end
 end

data/lib/quickbase_record/version.rb

@@ -1,3 +1,3 @@
 module QuickbaseRecord
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/spec/fakes/teacher_fake.rb

@@ -8,6 +8,7 @@ class TeacherFake
     :id => 3,
     :name => 6,
     :subject => 7,
-    :salary => 8
+    :salary => 8,
+    :attachment => 9
   })
 end

data/spec/queries_spec.rb

@@ -86,6 +86,14 @@ RSpec.describe QuickbaseRecord::Queries do
       cullen.subject = 'Ruby on Rails'
       cullen.name = "THE #{cullen.name}"
       expect(cullen.save.id).to be_truthy
+    end
+
+    it "uploads files" do
+      cullen = TeacherFake.where(name: 'THE Cullen Jett').first
+      cullen.attachment = {name: 'Test Attachment', file: 'LICENSE.txt'}
+      cullen.save
+      cullen = TeacherFake.find(cullen.id)
+      expect(cullen.attachment[:filename]).to eq('Test Attachment')
       cullen.delete
     end
   end
@@ -159,6 +167,11 @@ RSpec.describe QuickbaseRecord::Queries do
       expect(TeacherFake.build_query(hash)).to eq("{'3'.EX.'1'}OR{'3'.EX.'2'}")
     end
 
+    it "combines an all array query with OR" do
+      hash = [{id: 1, name: 'Cullen Jett'}]
+      expect(TeacherFake.build_query(hash)).to eq("{'3'.EX.'1'}OR{'6'.EX.'Cullen Jett'}")
+    end
+
     it "accepts custom comparators via a nested hash" do
       hash = {id: {XEX: 1}}
       expect(TeacherFake.build_query(hash)).to eq("{'3'.XEX.'1'}")

data/spec/quickbase_record_config.rb

@@ -1,5 +1,8 @@
+require 'yaml'
+creds = YAML.load_file("spec/config.yml")
+
 QuickbaseRecord.configure do |config|
   config.realm = "ais"
-  config.username = ENV["QB_USERNAME"]
-  config.password = ENV["QB_PASSWORD"]
+  config.username = creds["username"]
+  config.password = creds["password"]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickbase_record
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Cullen Jett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-15 00:00:00.000000000 Z
+date: 2015-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,6 +119,7 @@ files:
 - quickbase_record-0.2.0.gem
 - quickbase_record-0.2.1.gem
 - quickbase_record-0.2.2.gem
+- quickbase_record-0.2.3.gem
 - quickbase_record.gemspec
 - spec/fakes/student_fake.rb
 - spec/fakes/teacher_fake.rb