quickbase_record 0.3.2 → 0.3.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2RjMzgzMzNmNDcxMjQwZjAwNmE2YmM1YzljN2EwNDg0YTM5YTdiOA==
+    YzM2ODllMjE5Y2VjZTcxNGYxZTc0MGJlOTZlZmMxZWY5YWE0YzZiZA==
   data.tar.gz: !binary |-
-    NzY3NjAxMTE4ZmVlMDQ0ZDM3MDc2NTJmNGE1MWY3NjVjYzgzZjYwZA==
+    ODZkYjE3YjVmNWFhZjY2ZjUzYWEzYWZlYTUxN2FlZWEyYWM0NDRhNw==
 SHA512:
   metadata.gz: !binary |-
-    MjIyMzFkMGY3NWM2YzJiNjQ5OTI5OTA0Mzk4NDc3MWY4NDYwOTNhMzRkMTNl
-    MTQ4MDU5NzdkZjNmNWU0NDdmNmY2Y2EwNDJkZWFjYTNlN2U3Njk4MzdhOWJk
-    NTY5Y2JlYmQ4MzFiZTIzZmE2YmY5NjU5ZDNhZTAxOGY0M2ZhYWM=
+    ZWZmMjZlOWU0NjZmYjNlNDkxY2E2Yjk5YTgyNDQzOWZlZGQ5MDRmNTI5Nzc0
+    MDc0OWFiNmVmM2Q3MTBiY2YyMmU0ZTJiODY1MTFiNTU0YTkxNDhhNDdjMDMx
+    MTZhOWFmNTUzZjMzMGQ5Y2Y4ZjdhZjUzOWU2YThkNDVlNGI4Mjk=
   data.tar.gz: !binary |-
-    N2RiZWRlM2M5OGNkZTI4NmZmZGVkZWYzYzU4OGRhZGExZDZiZDJlZDkxOGQ5
-    OGMyYmU1ZjhlMTcxMTg4YTJiZDZiZmE2MzhkODI0MzJlODdmMGFhNzY4Y2E5
-    OGFlYjMzM2MyNjRjYjE0M2E5N2Y5NWFlNjFkMTU5MGU2MGViMzI=
+    MDBlMjU4ZGIwN2MzYjkxMzkxMTE3NWVjMzY0ODhhZWY2ODI0ZDNlMTkzNWY1
+    MTE2MGVmMjM2MDMwNzMxNmYxMTFkZWMxNTZjZGZlZDU0ZDIyN2Q4NGE1Yjdi
+    YzBkODY4YTRmNDQ5OGNlY2U1NWY4NWRmMWZlMmNkMWU4ZmM2N2U=

data/README.md

@@ -54,7 +54,7 @@ Simply `include QuickbaseRecord::Model` in your class and use the `.define_field
   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)
+**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.
 
 ### 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.
@@ -169,7 +169,7 @@ Database callbacks (i.e. `before_save :create_token!`) are not fully functional
 
   * **#delete**
     - Delete the corresponding record in QuickBase
-    - It returns the object's ID if successful or `false` if unsuccessful
+    - It returns the object if successful or `false` if unsuccessful
     ```
       @post = Post.find(1)
       @post.delete

data/lib/quickbase_record/field_mapping.rb

@@ -3,30 +3,7 @@ module QuickbaseRecord
     attr_accessor :fields
 
     def initialize(fields={})
-      # @fields = create_fields(fields)
       @fields = fields
     end
-
-    def create_fields(fields_hash)
-      converted_fields_hash = {}
-      fields_hash.each do |key, value|
-        converted_fields_hash[key] = Field.new(value)
-      end
-      return converted_fields_hash
-    end
-  end
-
-  class Field
-    attr_accessor :value
-
-    def initialize(value)
-      @value = format_value(value)
-    end
-
-    def format_value(value)
-      return value if value.is_a? Integer
-
-
-    end
   end
 end

data/lib/quickbase_record/model.rb

@@ -13,6 +13,7 @@ module QuickbaseRecord
     end
 
     module ClassMethods
+
       def fields(fields_hash={})
         @fields ||= FieldMapping.new(fields_hash).fields
       end

data/lib/quickbase_record/queries.rb

@@ -5,7 +5,6 @@ module QuickbaseRecord
     extend ActiveSupport::Concern
     include QuickbaseRecord::Client
 
-    UNWRITABLE_FIELDS = ['dbid', 'id', 'date_created', 'date_modified', 'record_owner', 'last_modified_by']
 
     module ClassMethods
       def dbid
@@ -140,7 +139,7 @@ module QuickbaseRecord
         self.fields[field_name.to_sym].to_s
       end
 
-      def covert_fid_to_field_name(fid)
+      def convert_fid_to_field_name(fid)
         self.fields.invert[fid.to_i]
       end
 
@@ -148,7 +147,7 @@ module QuickbaseRecord
         result = {}
 
         response.each do |fid, value|
-          field_name = covert_fid_to_field_name(fid)
+          field_name = convert_fid_to_field_name(fid)
           result[field_name] = value
         end
 
@@ -182,38 +181,53 @@ module QuickbaseRecord
     def save
       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)
+        current_object[fid.to_s] = public_send(field_name)
       end
 
-      current_object.delete_if { |key, value| value.nil? }
-
-      if self.id
+      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)
       else
-        self.id = qb_client.add_record(self.class.dbid, current_object)
+        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)
       end
 
       return self
     end
 
     def delete
-      return false unless self.id
-      successful = qb_client.delete_record(self.class.dbid, self.id)
-      return successful ? self.id : false
+      # 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)
+      return false unless rid
+
+      successful = qb_client.delete_record(self.class.dbid, rid)
+      return successful ? self : false
     end
 
     def update_attributes(attributes={})
       return false if attributes.blank?
+
       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? }
+
       if self.id
         qb_client.edit_record(self.class.dbid, self.id, updated_attributes)
       else
         self.id = qb_client.add_record(self.class.dbid, updated_attributes)
       end
+
       return self
     end
+
+    def remove_unwritable_fields(hash)
+      hash.delete_if do |key, value|
+        value.nil? || key.to_i <= 5 || key == :dbid
+      end
+    end
   end
 end

data/lib/quickbase_record/version.rb

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

data/spec/fakes/classroom_fake.rb

@@ -0,0 +1,14 @@
+require './lib/quickbase_record'
+
+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
+  })
+end

data/spec/fakes/student_fake.rb

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

data/spec/model_spec.rb

@@ -13,21 +13,6 @@ RSpec.describe QuickbaseRecord::Model do
 
       expect(StudentFake.fields[:id]).to eq(3)
     end
-
-    # it "formats fields as dates given a hash value" do
-    #   StudentFake.define_fields ({
-    #     :dbid => 'bjzrx8ckw',
-    #     :date_created => {date: 1},
-    #     :id => 3,
-    #     :name => 6,
-    #     :grade => 7,
-    #     :email => 8
-    #   })
-
-    #   puts StudentFake.find(1).inspect
-
-    #   expect(StudentFake.find(1).date_created).to eq('1/1/2015')
-    # end
   end
 
   describe 'initialize' do

data/spec/queries_spec.rb

@@ -1,4 +1,5 @@
 require './spec/fakes/teacher_fake'
+require './spec/fakes/classroom_fake'
 
 RSpec.describe QuickbaseRecord::Queries do
   describe '.find' do
@@ -82,44 +83,80 @@ RSpec.describe QuickbaseRecord::Queries do
   end
 
   describe '#save' 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')
-      cullen.save
-      expect(cullen.id).to be_truthy
-    end
-
-    it "returns the object on successful save" do
-      cullen = TeacherFake.where(name: 'Cullen Jett').first
-      expect(cullen.save).to be_a TeacherFake
-    end
-
-    it "edits an object that has an existing ID" do
-      cullen = TeacherFake.where(name: 'Cullen Jett').first
-      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
+    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')
+        cullen.save
+        expect(cullen.id).to be_truthy
+      end
+
+      it "returns the object on successful save" do
+        cullen = TeacherFake.where(name: 'Cullen Jett').first
+        expect(cullen.save).to be_a TeacherFake
+      end
+
+      it "edits an object that has an existing ID" do
+        cullen = TeacherFake.where(name: 'Cullen Jett').first
+        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
+
+    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.save
+        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.save
+        expect(english.record_id).to be_present
+        expect(english.record_id).not_to eq('2')
+        english.delete
+      end
+
+      it "edits a record if it has a record ID" do
+        science = ClassroomFake.find(101)
+        science.subject = 'SCIENCE!'
+        science.save
+        expect(science.subject).to eq('SCIENCE!')
+        science.update_attributes(subject: 'Science')
+      end
     end
   end
 
   describe '#delete' do
-    it "deletes an object from QuickBase" do
-      socrates = TeacherFake.new(name: 'Socrates')
-      socrates.save
-      old_id = socrates.id
-      expect(socrates.delete).to eq(old_id)
-    end
-
-    it "returns false if the object doesn't yet have an ID" do
-      expect(TeacherFake.new(name: 'Socrates').delete).to be false
+    context "when record ID is the primary key" do
+      it "deletes an object from QuickBase" do
+        socrates = TeacherFake.new(name: 'Socrates')
+        socrates.save
+        expect(socrates.delete).to eq(socrates)
+      end
+
+      it "returns false if the object doesn't yet have an ID" do
+        expect(TeacherFake.new(name: 'Socrates').delete).to be false
+      end
+    end
+
+    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.save
+        expect(gym.delete).to eq(gym)
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickbase_record
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Cullen Jett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-17 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ files:
 - lib/quickbase_record/queries.rb
 - lib/quickbase_record/version.rb
 - quickbase_record.gemspec
+- spec/fakes/classroom_fake.rb
 - spec/fakes/student_fake.rb
 - spec/fakes/teacher_fake.rb
 - spec/field_spec.rb
@@ -147,6 +148,7 @@ signing_key:
 specification_version: 4
 summary: An ActiveRecord-style ORM for using Intuit QuickBase tables as models.
 test_files:
+- spec/fakes/classroom_fake.rb
 - spec/fakes/student_fake.rb
 - spec/fakes/teacher_fake.rb
 - spec/field_spec.rb