airrecord 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa2416d29667f3621c84a16cf761cf065a98be8e
-  data.tar.gz: bbc197ae2c88828c9b90580e45d4cb011729ee21
+  metadata.gz: 0c7750e40929942d774da0aba5ad0672c550b3fc
+  data.tar.gz: 4a1f864a9970f156ed310d7f6635da316c73c7c3
 SHA512:
-  metadata.gz: 94ba94acd00c8262b7d77b75641721cfe4f61d2c9f8bd93b567154e128eb03ade3c3ddfda2d0e9db4b09b5bfd1d3c151901e6144f57f5238b73ce702843b75ea
-  data.tar.gz: 83392e39f08594d19976e2803c11c0e7ef4e34aec2a731bb569a845808d6311a67d9787393e884e44e67d2776aaf1934cc04270ec65a4043218938e012ec5ad1
+  metadata.gz: 359c165ea9163454dff7067029a08bccaa2a57d07c36a710a734dcc3321bf17162772c11debc6ab5800a443b1c47c1e1c701a321b0ed69f9e3d033bee16b7889
+  data.tar.gz: 2e1d2950f4f2c36fdb2dced7d5384f8652138e8b27f164efef1d7d9967fe0864ca7b7f839a0c3eaba306d169f23a500617ab92180f626d38527086a6912c2b97

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.2.1
+
+* Added comparison operator (#9)

data/README.md

@@ -22,9 +22,21 @@ class Tea < Airrecord::Table
 
   has_many :brews, class: 'Brew', column: "Brews"
 
+  def self.chinese
+    all(filter: '{Country} == "China"')
+  end
+
+  def self.cheapest_and_best
+    all(sort: { "Rating" => "desc", "Price" => "asc" })
+  end
+
   def location
     [self[:village], self[:country], self[:region]].compact.join(", ")
   end
+
+  def green?
+    self[:type] == "Green"
+  end
 end
 
 class Brew < Airrecord::Table
@@ -32,6 +44,14 @@ class Brew < Airrecord::Table
   self.table_name = "Brews"
 
   belongs_to :tea, class: 'Tea', column: 'Tea'
+
+  def self.hot
+    all(filter: "{Temperature} > 90")
+  end
+
+  def done_brewing?
+    self[:created_at] + self[:duration] > Time.now
+  end
 end
 
 teas = Tea.all
@@ -41,6 +61,18 @@ tea.location # instance methods
 tea[:brews] # associated brews
 ```
 
+A short-hand API for definitions and more ad-hoc querying is also available:
+
+```ruby
+Tea = Airrecord.table("api_key", "app_key", "Teas")
+
+Tea.all.each do |record|
+  puts "#{record.id}: #{record[:name]}"
+end
+
+Tea.find("rec3838")
+```
+
 ## Documentation
 
 ### Authentication
@@ -98,7 +130,7 @@ To use `filterbyFormula` to filter returned records:
 
 ```ruby
 # Retrieve all teas from China
-Tea.all(filter: "{Country} == "China")
+Tea.all(filter: '{Country} == "China"')
 
 # Retrieve all teas created in the past week
 Tea.all(filter: "DATETIME_DIFF(CREATED_TIME(), TODAY(), 'days') < 7")
@@ -178,8 +210,8 @@ tea = Tea.find("someid")
 tea[:name] = "Feng Gang Organic"
 
 # Since the Village column is not set, we do not have access to a snake-cased
-variant since the mapping is not determined. For all we know, the correct column
-name could be "VilLlaGe". Therefore, we must use the proper column name.
+# variant since the mapping is not determined. For all we know, the correct column
+# name could be "VilLlaGe". Therefore, we must use the proper column name.
 tea["Village"] = "Feng Gang"
 
 tea.save # persist to Airtable
@@ -252,15 +284,17 @@ Brew.create("Tea" => tea, "Temperature" => "80", "Time" => "4m", "Rating" => "5"
 
 Airrtable provides a simple, ad-hoc API that will instantiate an anonymous
 `Airrecord::Table` for you on the fly with the configured key, app, and table.
+This is useful if you require no custom definitions, or you're just playing
+around.
 
 ```ruby
-teas = Airrecord.table("key1", "app1", "Teas")
+Tea = Airrecord.table("api_key", "app_key", "Teas")
 
-teas.records.each do |record|
+Tea.all.each do |record|
   puts "#{record.id}: #{record[:name]}"
 end
 
-p teas.find(teas.records.first.id)
+Tea.find("rec3838")
 ```
 
 ### Snake-cased helper methods

data/lib/airrecord/table.rb

@@ -197,6 +197,11 @@ module Airrecord
       }]
     end
 
+    def ==(other)
+      self.class == other.class &&
+        serializable_fields == other.serializable_fields
+    end
+
     protected
 
     def association(key)

data/lib/airrecord/version.rb

@@ -1,3 +1,3 @@
 module Airrecord
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airrecord
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Simon Eskildsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-04 00:00:00.000000000 Z
+date: 2017-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -103,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md