quickbase_record 0.3.3 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzM2ODllMjE5Y2VjZTcxNGYxZTc0MGJlOTZlZmMxZWY5YWE0YzZiZA==
+    OWYxNzdkYjc3ZjQxY2QxM2JhNmE3ZWEzNWU5YTU0ZDhmYWQ4YTY3YQ==
   data.tar.gz: !binary |-
-    ODZkYjE3YjVmNWFhZjY2ZjUzYWEzYWZlYTUxN2FlZWEyYWM0NDRhNw==
+    NTgwYzI4Njk3Y2IxZWZhMzFkMWYxNjY3YzNjNjUxZTY5M2UxYzg5NA==
 SHA512:
   metadata.gz: !binary |-
-    ZWZmMjZlOWU0NjZmYjNlNDkxY2E2Yjk5YTgyNDQzOWZlZGQ5MDRmNTI5Nzc0
-    MDc0OWFiNmVmM2Q3MTBiY2YyMmU0ZTJiODY1MTFiNTU0YTkxNDhhNDdjMDMx
-    MTZhOWFmNTUzZjMzMGQ5Y2Y4ZjdhZjUzOWU2YThkNDVlNGI4Mjk=
+    MGYwNzM3N2JjM2ViZjUwZTI0MjZhYTkyMDBlMmM0MWU0MjhlMmYwNTU1MmFh
+    ZTU0N2EyYzc0YmYyMGZmYzZhOTkxYmJiYTQ5NzljNDkwYzYyNjFmYjJmZjlh
+    OWQwNjQ2ZjQwMjg3ZmMwZDI1N2U0ODVmMmYzM2VmYzM2MjAxNTc=
   data.tar.gz: !binary |-
-    MDBlMjU4ZGIwN2MzYjkxMzkxMTE3NWVjMzY0ODhhZWY2ODI0ZDNlMTkzNWY1
-    MTE2MGVmMjM2MDMwNzMxNmYxMTFkZWMxNTZjZGZlZDU0ZDIyN2Q4NGE1Yjdi
-    YzBkODY4YTRmNDQ5OGNlY2U1NWY4NWRmMWZlMmNkMWU4ZmM2N2U=
+    NjQ4Nzc5Mjk2NTQwMTYxYjczOGQ3ZjcwMDEzYmQyNDI5ZmM3NjViZTYzMjZk
+    NzU0YmY3NzEwYzgxMDgxZWFlNDY4NTNlOGZhNTg4OTg2MThlYjZmZTdiZDQ3
+    MGNkNTVlZjVhY2Y1ZmUyZGU1NjlhYTFlOWVmNjgzNWU1Y2U2MGY=

data/.gitignore

@@ -13,5 +13,5 @@
 *.a
 mkmf.log
 /spec/config.yml
-.DS_Store
+*.DS_Store
 *.gem

data/README.md

@@ -20,22 +20,27 @@ Or install it yourself as:
 
 ## Usage
 
+  * [Methods](#available-methods)
+
 ### Initialize the API Client
-QuickbaseRecord is built on top of the [Advantage Quickbase](https://github.com/AdvantageIntegratedSolutions/Quickbase-Gem) gem to make the API calls to QuickBase, so you'll need to configure QuickbaseRecord with your app's realm name and provide a valid username and password. This can be done in a single initializer file with a call to `QuickbaseRecords.configure`, making sure to keep your credentials safe from the world.
+QuickbaseRecord is built on top of the [Advantage Quickbase](https://github.com/AdvantageIntegratedSolutions/Quickbase-Gem) gem to make the API calls to QuickBase, so you'll need to configure QuickbaseRecord with your app's realm name and provide a valid username, password, and token (if applicable). This can be done in a single initializer file with a call to `QuickbaseRecords.configure`.
 
 ```
   # config/initializers/quickbase_record.rb
 
   QuickbaseRecord.configure do |config|
-    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"
+    config.realm = "quickbase_app_realm_name"
+    config.username = "valid_username"
+    config.password = "valid_password"
+    config.token = "quickbase_app_token_if_applicable"
   end
 ```
 
 ### Include it in your Class
-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
+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.
+
+**(NEW IN 0.4.0)**
+.define_fields follows a similar pattern to ActiveRecord migrations. It takes a block where data types and field names are definied with a corresponding QuickBase FID.
 
 ```
   # app/models/post.rb
@@ -43,18 +48,58 @@ Simply `include QuickbaseRecord::Model` in your class and use the `.define_field
   class Post
     include QuickbaseRecord::Model
 
-    define_fields ({
-      dbid: 'abcde12345'
-      id: 3,
-      content: 7,
-      author: 8
+    define_fields do |t|
+      t.dbid 'abcde12345'
+      t.number :id, 3, :primary_key
+      t.string :content, 7
+      t.string :author, 8
+      t.string :title, 9
+      t.string :title_plus_author, 10, :read_only
     })
 
     # 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). If your table does not use [Record ID] as it's primary key then you must supply a key/value pair for :record_id and assign :id to the primary key.
+### .define_fields
+.define_fields(:field_name, fid, *options)
+
+The following data types are currently supported:
+
+  * **dbid**
+    - The dbid for the QuickBase table
+    - **Does not take multiple arguments, only a string of the dbid**
+
+  * **string**
+    - All values are converted to a String
+
+  * **number**
+    - All values are converted to a Numeric (and knows if it needs to be a float)
+  * **date**
+    - All values are converted to a string representation of the date value: "07/30/2015" or nil for empty values
+  * **file_attachment**
+    - Doesn't really do anything, only makes you feel better :) File attachments are explained below.
+
+Additional options may be added to field definitions:
+
+  * **:primary_key**
+    - This is a required option for one field.
+  * **:read_only**
+    - Fields marked as :read_only will not respond to #save or #update_attributes calls.
+    - Useful for formula/lookup/other fields in your QuickBase table that you can't write to.
+
+
+**IMPORTANT: You must supply a "dbid" data type and mark a single field as :primary_key**
+
+### Queries
+To query for records you can use the .find, .where, or .qid methods on the class. See below for examples.
+
+If you want to see the QuickBase query string output of a .where() argument you can pass your query hash to the .build_query() method and it will return the QuickBase query.
+
+```
+Post.build_query(author: 'Cullen', title: 'Some Title')
+=> "{'8'.EX.'Cullen'}AND{'9'.EX.'Some Title'}"
+```
 
 ### What You Get
 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.

data/lib/quickbase_record/field.rb

@@ -0,0 +1,9 @@
+class Field
+  attr_accessor :field_name, :fid, :options
+
+  def initialize(args={})
+    @field_name = args[:field_name]
+    @fid = args[:fid]
+    @options = args[:options]
+  end
+end

data/lib/quickbase_record/fields/date_field.rb

@@ -0,0 +1,12 @@
+require_relative 'field'
+
+class DateField < Field
+  def initialize(*args)
+    super(*args)
+  end
+
+  def convert(value)
+    return nil if value == ""
+    Time.at(value.to_i / 1000).strftime("%m/%d/%Y")
+  end
+end

data/lib/quickbase_record/fields/field.rb

@@ -0,0 +1,13 @@
+class Field
+  attr_accessor :field_name, :fid, :options
+
+  def initialize(args={})
+    @field_name = args[:field_name]
+    @fid = args[:fid]
+    @options = args[:options]
+  end
+
+  def convert(value)
+    Raise "#{self.class} must implement #convert to be a true subclass of Field"
+  end
+end

data/lib/quickbase_record/fields/file_attachment_field.rb

@@ -0,0 +1,11 @@
+require_relative 'field'
+
+class FileAttachmentField < Field
+  def initialize(*args)
+    super(*args)
+  end
+
+  def convert(value)
+    value
+  end
+end

data/lib/quickbase_record/fields/number_field.rb

@@ -0,0 +1,11 @@
+require_relative 'field'
+
+class NumberField < Field
+  def initialize(*args)
+    super(*args)
+  end
+
+  def convert(value)
+    value.match(/\./) ? value.to_f : value.to_i
+  end
+end

data/lib/quickbase_record/fields/string_field.rb

@@ -0,0 +1,11 @@
+require_relative 'field'
+
+class StringField < Field
+  def initialize(*args)
+    super(*args)
+  end
+
+  def convert(value)
+    value.to_s
+  end
+end

data/lib/quickbase_record/model.rb

@@ -1,3 +1,5 @@
+require_relative 'table_definition'
+
 module QuickbaseRecord
   module Model
     extend ActiveSupport::Concern
@@ -13,19 +15,21 @@ module QuickbaseRecord
     end
 
     module ClassMethods
+      attr_accessor :fields, :dbid
 
-      def fields(fields_hash={})
-        @fields ||= FieldMapping.new(fields_hash).fields
-      end
-
-      def define_fields(fields)
-        fields(fields)
+      def define_fields
+        table_definition = TableDefinition.new
+        yield table_definition
+        @dbid = table_definition.fields[:dbid]
+        @fields = table_definition.fields.reject { |field_name, field| field_name == :dbid }
       end
     end
 
     def initialize(attributes={})
       create_attr_accesssors
       assign_attributes(attributes) if attributes
+
+      super()
     end
 
     def persisted?
@@ -33,7 +37,7 @@ module QuickbaseRecord
     end
 
     def create_attr_accesssors
-      self.class.fields.each do |field_name, value|
+      self.class.fields.each do |field_name, field|
         self.class.send(:attr_accessor, field_name)
       end
     end

data/lib/quickbase_record/queries.rb

@@ -5,19 +5,18 @@ module QuickbaseRecord
     extend ActiveSupport::Concern
     include QuickbaseRecord::Client
 
-
     module ClassMethods
-      def dbid
-        @dbid ||= fields[:dbid]
-      end
-
       def clist
-        @clist ||= fields.reject{ |field_name| field_name == :dbid }.values.join('.')
+        @clist ||= fields.reject{ |field_name, field| field_name == :dbid }.values.collect {|field| field.fid }.join('.')
       end
 
-      def find(id, query_options = {})
+      def find(id, query_options={})
         query_options = build_query_options(query_options[:query_options])
-        clist = query_options.delete(:clist) if query_options[:clist]
+        if query_options[:clist]
+          clist = query_options.delete(:clist)
+        else
+          clist = self.clist
+        end
         query = { query: build_query(id: id), clist: clist }.merge(query_options)
         query_response = qb_client.do_query(dbid, query).first
 
@@ -34,7 +33,11 @@ module QuickbaseRecord
           options = {}
         end
 
-        clist = options.delete(:clist) if options[:clist]
+        if options[:clist]
+          clist = options.delete(:clist)
+        else
+          clist = self.clist
+        end
 
         query = { query: build_query(query_hash), clist: clist }.merge(options)
         query_response = qb_client.do_query(dbid, query)
@@ -44,19 +47,19 @@ module QuickbaseRecord
         build_collection(query_response)
       end
 
-      def create(attributes = {})
+      def create(attributes={})
         object = new(attributes)
         object.save
         return object
       end
 
       def qid(id)
-        query = { qid: id, clist: clist }
-        query_response = qb_client.do_query(dbid, query)
+        query_options = { qid: id, clist: clist }
+        query_response = qb_client.do_query(dbid, query_options)
 
         return [] if query_response.first.nil?
 
-        build_collection(query_response)
+        build_array_of_new_objects(query_response)
       end
 
       def build_query(query_hash)
@@ -96,7 +99,7 @@ module QuickbaseRecord
             if result[option_name]
               result[option_name] << ".#{convert_field_name_to_fid(value)}"
             else
-              result[option_name] = convert_field_name_to_fid(value)
+              result[option_name] = convert_field_name_to_fid(value).to_s
             end
           end
         end
@@ -111,6 +114,13 @@ module QuickbaseRecord
         end
       end
 
+      def build_array_of_new_objects(query_response)
+        query_response.map do |response|
+          converted_response = convert_quickbase_response(response)
+          new(converted_response)
+        end
+      end
+
       def join_with_and(fid, value, comparator="EX")
         "{'#{fid}'.#{comparator}.'#{value}'}"
       end
@@ -136,18 +146,20 @@ module QuickbaseRecord
       end
 
       def convert_field_name_to_fid(field_name)
-        self.fields[field_name.to_sym].to_s
+        fields[field_name.to_sym].fid
       end
 
-      def convert_fid_to_field_name(fid)
-        self.fields.invert[fid.to_i]
+      def covert_fid_to_field_name(fid)
+        fields.select { |field_name, field| field.fid == fid.to_i }.values.first.field_name
       end
 
       def convert_quickbase_response(response)
         result = {}
 
         response.each do |fid, value|
-          field_name = convert_fid_to_field_name(fid)
+          field = fields.select { |field_name, field| field.fid == fid.to_i }.values.first
+          field_name = field.field_name
+          value = field.convert(value)
           result[field_name] = value
         end
 
@@ -160,17 +172,17 @@ module QuickbaseRecord
 
         return query_string unless uses_field_name
 
-        fields.each do |field_name, fid|
-          field_name = field_name.to_s
+        fields.each do |field_name, field|
           match_string = "\{'?(#{field_name})'?\..*\.'?.*'?\}"
+
           if query_string.scan(/#{match_string}/).length > 0
-            query_string.gsub!(field_name, fid.to_s)
+            query_string.gsub!(field_name.to_s, field.fid.to_s)
             match_found = true
           end
         end
 
         if !match_found
-          raise ArgumentError, "Invalid arguments on #{self}.where() - no matching field name found. \nMake sure the field is part of your class configuration."
+          raise ArgumentError, "Invalid arguments on #{self}.query() - no matching field name found. \nMake sure the field is part of your class configuration."
         end
 
         return query_string
@@ -178,20 +190,32 @@ module QuickbaseRecord
     end
 
     # INSTANCE METHODS
+    def writable_fields
+      @writable_fields ||= self.class.fields.reject{ |field_name, field| field.options.include?(:read_only) }
+    end
+
+    def primary_key_field_name
+      @primary_key_field ||= self.class.fields.select { |field_name, field| field.options.include?(:primary_key) }.keys.first
+    end
+
+    def record_id_field_name
+      @record_id_field_name ||= self.class.fields.select { |field_name, field| field.fid == 3 }.keys.first
+    end
+
     def save
+      primary_key = public_send(primary_key_field_name)
       current_object = {}
-      self.class.fields.each do |field_name, fid|
-        current_object[fid.to_s] = public_send(field_name)
+      self.class.fields.each do |field_name, field|
+        current_object[field.fid] = public_send(field_name)
       end
 
-      if current_object['3'] #object has a record_id, so we'll edit it
+      if current_object[3] #object has a record_id, so we'll edit it
         remove_unwritable_fields(current_object)
-        qb_client.edit_record(self.class.dbid, self.id, current_object)
+        qb_client.edit_record(self.class.dbid, primary_key, current_object)
       else
         remove_unwritable_fields(current_object)
         new_rid = qb_client.add_record(self.class.dbid, current_object)
-        id_field_name = self.class.fields.select { |field_name, fid| fid == 3 }.keys.first
-        public_send("#{id_field_name}=", new_rid)
+        public_send("#{record_id_field_name}=", new_rid)
       end
 
       return self
@@ -199,8 +223,7 @@ module QuickbaseRecord
 
     def delete
       # we have to use [record id] because of the advantage_quickbase gem
-      id_field_name = self.class.fields.select { |field_name, fid| fid == 3 }.keys.first
-      rid = public_send(id_field_name)
+      rid = public_send(record_id_field_name)
       return false unless rid
 
       successful = qb_client.delete_record(self.class.dbid, rid)
@@ -213,20 +236,26 @@ module QuickbaseRecord
       self.assign_attributes(attributes)
       updated_attributes = {}
       attributes.each { |field_name, value| updated_attributes[self.class.convert_field_name_to_fid(field_name)] = value }
-      updated_attributes.delete_if { |key, value| value.nil? }
+      primary_key = public_send(primary_key_field_name)
+      record_id = public_send(record_id_field_name)
 
-      if self.id
-        qb_client.edit_record(self.class.dbid, self.id, updated_attributes)
+      if record_id
+        remove_unwritable_fields(updated_attributes)
+        qb_client.edit_record(self.class.dbid, primary_key, updated_attributes)
       else
-        self.id = qb_client.add_record(self.class.dbid, updated_attributes)
+        remove_unwritable_fields(updated_attributes)
+        new_id = qb_client.add_record(self.class.dbid, updated_attributes)
+        public_send("#{record_id_field_name}=", new_id)
       end
 
       return self
     end
 
     def remove_unwritable_fields(hash)
-      hash.delete_if do |key, value|
-        value.nil? || key.to_i <= 5 || key == :dbid
+      writable_fids = writable_fields.values.collect { |field| field.fid }
+
+      hash.delete_if do |fid, value|
+        value.nil? || !writable_fids.include?(fid)
       end
     end
   end

data/lib/quickbase_record/table_definition.rb

@@ -0,0 +1,44 @@
+require 'quickbase_record/fields/string_field'
+require 'quickbase_record/fields/number_field'
+require 'quickbase_record/fields/date_field'
+require 'quickbase_record/fields/file_attachment_field'
+
+class TableDefinition
+  attr_accessor :fields
+
+  def initialize
+    @fields = {}
+  end
+
+  def dbid(dbid_string)
+    fields[:dbid] = dbid_string
+  end
+
+  def string(field_name, fid, *options)
+    field_name = field_name.to_sym
+    fid = fid.to_i
+
+    fields[field_name] = StringField.new(field_name: field_name, fid: fid, options: options)
+  end
+
+  def number(field_name, fid, *options)
+    field_name = field_name.to_sym
+    fid = fid.to_i
+
+    fields[field_name] = NumberField.new(field_name: field_name, fid: fid, options: options)
+  end
+
+  def file_attachment(field_name, fid, *options)
+    field_name = field_name.to_sym
+    fid = fid.to_i
+
+    fields[field_name] = FileAttachmentField.new(field_name: field_name, fid: fid, options: options)
+  end
+
+  def date(field_name, fid, *options)
+    field_name = field_name.to_sym
+    fid = fid.to_i
+
+    fields[field_name] = DateField.new(field_name: field_name, fid: fid, options: options)
+  end
+end

data/lib/quickbase_record/version.rb

@@ -1,3 +1,3 @@
 module QuickbaseRecord
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/lib/quickbase_record.rb

@@ -3,7 +3,6 @@ require 'active_support/all'
 require 'active_model'
 require 'quickbase' # This is the file name for the 'advantage_quickbase' gem. Idk why Ben named it this way...
 require_relative 'quickbase_record/configuration'
-require_relative 'quickbase_record/field_mapping'
 require_relative 'quickbase_record/client'
 require_relative 'quickbase_record/queries'
 require_relative 'quickbase_record/model'

data/quickbase_record.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "shoulda-matchers"
 
   spec.add_runtime_dependency "advantage_quickbase"
   spec.add_runtime_dependency "activesupport"

data/spec/fakes/classroom_fake.rb

@@ -4,11 +4,12 @@ class ClassroomFake
   include QuickbaseRecord::Model
 
   # primary key is not record id
-  define_fields ({
-    dbid: 'bj4yju38j',
-    date_created: 1,
-    record_id: 3,
-    id: 6,
-    subject: 7
-  })
+  define_fields do |t|
+    t.dbid 'bj4yju38j'
+    t.date :date_created, 1, :read_only
+    t.number :record_id, 3, :read_only
+    t.number :id, 6, :primary_key
+    t.string :subject, 7
+    t.string :subject_plus_room, 8, :read_only
+  end
 end

data/spec/fakes/student_fake.rb

@@ -2,12 +2,4 @@ require './lib/quickbase_record'
 
 class StudentFake
   include QuickbaseRecord::Model
-
-  define_fields ({
-    :dbid => 'bjzrx8ckw',
-    :id => 3,
-    :name => 6,
-    :grade => 7,
-    :email => 8
-  })
 end

data/spec/fakes/teacher_fake.rb

@@ -3,12 +3,12 @@ require './lib/quickbase_record'
 class TeacherFake
   include QuickbaseRecord::Model
 
-  define_fields ({
-    :dbid => "bjzrx8cjn",
-    :id => 3,
-    :name => 6,
-    :subject => 7,
-    :salary => 8,
-    :attachment => 9
-  })
+  define_fields do |t|
+    t.dbid "bjzrx8cjn"
+    t.number :id, 3, :primary_key, :read_only
+    t.string :name, 6
+    t.string :subject, 7
+    t.number :salary, 8
+    t.file_attachment :attachment, 9
+  end
 end

data/spec/field_spec.rb

@@ -1,14 +1,39 @@
-# require 'quickbase_record/field_mapping'
-
-# RSpec.describe QuickbaseRecord::Field do
-#   describe '#value' do
-#     it "returns the value if an integer is passed" do
-#       expect(QuickbaseRecord::Field.new(123).value).to eq(123)
-#     end
-
-#     it "returns a formatted date if a hash with the key :date is passed" do
-#       value = {date: 123}
-#       expect(QuickbaseRecord::Field.new(value).to)
-#     end
-#   end
-# end
+require 'quickbase_record/fields/field'
+require 'quickbase_record/fields/string_field'
+require 'quickbase_record/fields/number_field'
+require 'quickbase_record/fields/date_field'
+require 'quickbase_record/fields/file_attachment_field'
+
+RSpec.describe StringField do
+  describe '#convert' do
+    it "returns a string" do
+      expect(StringField.new.convert(123)).to eq('123')
+    end
+  end
+end
+
+RSpec.describe NumberField do
+  describe '#convert' do
+    it "returns a number" do
+      expect(NumberField.new.convert('123')).to eq(123)
+    end
+
+    it "returns a float" do
+      expect(NumberField.new.convert('123.45')).to eq(123.45)
+    end
+  end
+end
+
+RSpec.describe DateField do
+  describe '#convert' do
+    it "converts ms to a formated date string" do
+      now_in_ms = Time.now.to_f * 1000
+      now_as_string = DateTime.now.strftime('%m/%d/%Y')
+      expect(DateField.new.convert(now_in_ms)).to eq(now_as_string)
+    end
+
+    it "returns nil when passed an empty string" do
+      expect(DateField.new.convert("")).to be_nil
+    end
+  end
+end

data/spec/model_spec.rb

@@ -3,15 +3,16 @@ require './spec/fakes/student_fake'
 RSpec.describe QuickbaseRecord::Model do
   describe '.define_fields' do
     it "sets the class field mappings for field names => FIDs" do
-      StudentFake.define_fields ({
-        :dbid => 'bjzrx8ckw',
-        :id => 3,
-        :name => 6,
-        :grade => 7,
-        :email => 8
-      })
+      StudentFake.define_fields do |t|
+        t.dbid "abc123"
+        t.number :id, 3, :primary_key, :read_only
+        t.date :date_created, 4
+        t.string :name, 6
+        t.number :grade, 7, :read_only
+        t.string :email, 8
+      end
 
-      expect(StudentFake.fields[:id]).to eq(3)
+      expect(StudentFake.fields[:id].fid).to eq(3)
     end
   end
 

data/spec/queries_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe QuickbaseRecord::Queries do
   describe '.find' do
     it "finds a single Teacher given an ID" do
       teacher = TeacherFake.find(1)
-      expect(teacher.id).to eq("1")
+      expect(teacher.id).to eq(1)
     end
 
     it "returns an object of the Teacher class" do
@@ -37,12 +37,12 @@ RSpec.describe QuickbaseRecord::Queries do
 
     it "accepts a string in QuickBase query format" do
       teachers = TeacherFake.where("{'3'.EX.'1'}")
-      expect(teachers.first.id).to eq('1')
+      expect(teachers.first.id).to eq(1)
     end
 
     it "accepts a string in QuickBase query format using field names" do
       teachers = TeacherFake.where("{'id'.EX.'1'}")
-      expect(teachers.first.id).to eq('1')
+      expect(teachers.first.id).to eq(1)
     end
 
     it "returns an empty array if no QuickBase records are found" do
@@ -51,7 +51,7 @@ RSpec.describe QuickbaseRecord::Queries do
     end
 
     it "accepts query options" do
-      teachers = TeacherFake.where(subject: ['Gym', 'Biology'], query_options: {slist: 'subject', options: 'sortorder-D'})
+      teachers = TeacherFake.where(subject: ['Biology', 'Gym'], query_options: {slist: 'subject', options: 'sortorder-D'})
       expect(teachers.first.subject).to eq('Gym')
     end
 
@@ -83,6 +83,13 @@ RSpec.describe QuickbaseRecord::Queries do
   end
 
   describe '#save' do
+    it "doesn't save :read_only fields" do
+      classroom = ClassroomFake.find(101)
+      classroom.assign_attributes(subject_plus_room: "this shouldn't save")
+      classroom.save
+      expect(ClassroomFake.find(101).subject_plus_room).not_to eq("this shouldn't save")
+    end
+
     context "when record ID is the primary key" do
       it "creates a new record in QuickBase for an object without an ID and sets it's new ID" do
         cullen = TeacherFake.new(name: 'Cullen Jett', salary: '1,000,000.00')
@@ -114,17 +121,17 @@ RSpec.describe QuickbaseRecord::Queries do
 
     context "when record ID is not the primary key" do
       it "creates a new record if the object doesn't have a record ID" do
-        math = ClassroomFake.new(id: '1', subject: 'Math')
+        math = ClassroomFake.new(id: 1, subject: 'Math')
         math.save
-        expect(ClassroomFake.find('1')).not_to be_nil
+        expect(ClassroomFake.find(1)).not_to be_nil
         math.delete
       end
 
       it "sets the object's record id for new records" do
-        english = ClassroomFake.new(id: '2', subject: 'English', date_created: 'this should not save')
+        english = ClassroomFake.new(id: 2, subject: 'English', date_created: 'this should not save')
         english.save
         expect(english.record_id).to be_present
-        expect(english.record_id).not_to eq('2')
+        expect(english.record_id).not_to eq(2)
         english.delete
       end
 
@@ -153,7 +160,7 @@ RSpec.describe QuickbaseRecord::Queries do
 
     context "when record ID is not the primary key" do
       it "deletes the record from QuickBase" do
-        gym = ClassroomFake.new(id: '3', subject: 'Gym')
+        gym = ClassroomFake.new(id: 3, subject: 'Gym')
         gym.save
         expect(gym.delete).to eq(gym)
       end
@@ -196,6 +203,12 @@ RSpec.describe QuickbaseRecord::Queries do
       teacher.update_attributes()
       expect(teacher.update_attributes()).to be false
     end
+
+    it "doesn't save :read_only attributes" do
+      classroom = ClassroomFake.find(101)
+      classroom.update_attributes(subject_plus_room: "this shouldn't save")
+      expect(ClassroomFake.find(101).subject_plus_room).not_to eq("this shouldn't save")
+    end
   end
 
   # This is sort of a private method, but it seems pretty important so I'm keeping these tests.
@@ -254,7 +267,7 @@ RSpec.describe QuickbaseRecord::Queries do
 
   describe '.build_query_options' do
     it "returns a hash" do
-      options = {clist: '1.2.3'}
+      options = {clist: 'id.salary'}
       expect(TeacherFake.build_query_options(options)).to be_a Hash
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickbase_record
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Cullen Jett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: advantage_quickbase
   requirement: !ruby/object:Gem::Requirement
@@ -111,9 +125,15 @@ files:
 - lib/quickbase_record.rb
 - lib/quickbase_record/client.rb
 - lib/quickbase_record/configuration.rb
-- lib/quickbase_record/field_mapping.rb
+- lib/quickbase_record/field.rb
+- lib/quickbase_record/fields/date_field.rb
+- lib/quickbase_record/fields/field.rb
+- lib/quickbase_record/fields/file_attachment_field.rb
+- lib/quickbase_record/fields/number_field.rb
+- lib/quickbase_record/fields/string_field.rb
 - lib/quickbase_record/model.rb
 - lib/quickbase_record/queries.rb
+- lib/quickbase_record/table_definition.rb
 - lib/quickbase_record/version.rb
 - quickbase_record.gemspec
 - spec/fakes/classroom_fake.rb

data/lib/quickbase_record/field_mapping.rb

@@ -1,9 +0,0 @@
-module QuickbaseRecord
-  class FieldMapping
-    attr_accessor :fields
-
-    def initialize(fields={})
-      @fields = fields
-    end
-  end
-end