airrecord 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dc85eb8f47b96d2d03f3c2d8ede44021184acce8
-  data.tar.gz: 3177b982ce62cbe58dbade3fd5e5e24dbe43bf9d
+SHA256:
+  metadata.gz: 0e5fbb9f72ea43cf78e32e2a6dbfb0138b5732f3171cfe4416630b84e26d643e
+  data.tar.gz: b232483322295e61cd75a09cb56a04a67e673b01ecd27b8aee551e54b91ee45e
 SHA512:
-  metadata.gz: 25d59a038cbd3d619443274a9ddf415767d39f98c46a2f695bad07f60a2d4e4a941325f8957c0f4e938a5d8215c0f2f90578209ce35e24c18268ecd14c6673bd
-  data.tar.gz: cc387e3388f477a9dd538b3f6970486dbff04feed46644603ff17840225d6474b597a38c32fba69b9be779d0ba1dab2873f0817f907e1261fbb51cea6a6f8d21
+  metadata.gz: ce0d4a831cd0e2de8d5725b7ad66298ed061d920ee713b2bb0a54bde1c17e5b123e5edc00760b832c1f36ae2f3586bf1cc218fb4982bea265fbc6703c897d358
+  data.tar.gz: 115ab85c06ad0934d11e9f8d1a246a155f374300f60cf4c32019c3624e72794ea01d659464649b440ff793296ac2ce9b757feea3d41644fcf10b33770da10ead

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.2.4
+
+* Don't flag as dirty if change is equal
+
 # 0.2.3
 
 * Allow single associations (#12)

data/README.md

@@ -134,6 +134,9 @@ Tea.all(filter: '{Country} == "China"')
 
 # Retrieve all teas created in the past week
 Tea.all(filter: "DATETIME_DIFF(CREATED_TIME(), TODAY(), 'days') < 7")
+
+# Retrieve all teas that don't have a country defined
+Tea.all(filter: "{Country} == \"\"")
 ```
 
 This filtering can, of course, also be done in Ruby directly after calling
@@ -226,6 +229,39 @@ tea = Tea.find("rec839")
 tea.destroy # deletes record
 ```
 
+### File Uploads
+
+Airtable's API requires you to have uploaded your file to an intermediary and
+providing the URL. Unfortunately, it does not allow uploading directly.
+
+```ruby
+word = World.find("cantankerous")
+word["Pronounciation"] = [{url: "https://s3.ca-central-1.amazonaws.com/word-pronunciations/cantankerous.mp3}]
+word.save
+```
+
+S3 is a good place to upload files for Airtable. Airrecord does not support this
+directly, but the snippet below may be helpful:
+
+```ruby
+# Add this to your gemfile
+# Full docs at https://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Client.html
+require 'aws-sdk-s3'
+
+Aws.config.update(
+  credentials: Aws::Credentials.new(access_key, secret_key) # obtain from AWS
+  region: 'ca-central-1', # region
+)
+
+s3 = Aws::S3::Client.new
+s3.put_object({
+  body: File.open("cantankerous.mp3"), # IO object
+  bucket: 'word-pronunciations',
+  key: 'cantankerous.mp3',
+  acl: "public-read",
+})
+```
+
 ### Associations
 
 Airrecord supports managing associations between tables by linking
@@ -305,6 +341,54 @@ and _only_ if the column was set. If it's `nil`, it will not exist. That means
 if you want to set column that has a `nil` value for a column type, you'll have
 to fully type it out.
 
+### Production Middlewares
+
+For production use-cases, it's worth considering adding retries and circuit
+breakers to Airrecord. This is _not_ enabled by default. Airrecord uses the
+Faraday gem for HTTP. Similar to Rack, you can add middlewares to provide
+reusable logic for making HTTP requests.
+
+#### Configuring Retries
+
+Refer to the documentation for [all configuration
+options](http://www.rubydoc.info/gems/faraday/0.9.2/Faraday/Request/Retry).
+
+```ruby
+Airrecord::Table.client.connection.request :retry,
+  max: 5, interval: 1, interval_randomness: 2, backoff_factor: 2,
+  exceptions: [...] # It's suggested to be explicit here instead of relying on defaults
+```
+
+If you are running background scripts or workers with the sole purpose of
+communicating with Airtable, it may be worth retrying on failures. Note that
+this may cause the process to sleep for many seconds, so choose your values
+carefully.
+
+The `Net::HTTP` library that Faraday uses behind the scenes by default has
+opaque exceptions. If you choose to go beyond retrying on timeouts (as is
+provided by default by the Retry middleware), I suggest referring to a complete
+list of `Net::HTTP` exceptions, such as [this
+one](https://github.com/Shopify/semian/blob/master/lib/semian/net_http.rb#L35-L44).
+
+### Circuit Breaker
+
+If you're calling Airtable in an application and want to avoid hanging processes
+when Airtable is unavailable, we strongly recommend configuring [circuit
+breakers](https://github.com/Shopify/semian#circuit-breaker). This is a
+mechanism that after `threshold` failures, it'll start failing immediately
+instead of waiting until the timeout. This can avoid outages where all workers
+are hung trying to talk to a service that will never return, instead of serving
+useful fallbacks or requests that don't rely on the service. Failing fast is
+paramount for building reliable systems.
+
+You can configure a middleware such as
+[`faraday_middleware-circuit_breaker`](https://github.com/textmaster/faraday_middleware-circuit_breaker):
+
+```ruby
+Airrecord::Table.client.connection.request :circuit_breaker,
+  timeout: 20, threshold: 5
+```
+
 ## Contributing
 
 Contributions will be happily accepted in the form of Github Pull Requests!

data/lib/airrecord/table.rb

@@ -90,7 +90,7 @@ module Airrecord
       alias_method :all, :records
     end
 
-    attr_reader :fields, :column_mappings, :id, :created_at, :updated_fields
+    attr_reader :fields, :column_mappings, :id, :created_at, :updated_keys
 
     def initialize(fields, id: nil, created_at: nil)
       @id = id
@@ -126,9 +126,11 @@ module Airrecord
 
     def []=(key, value)
       if fields[key]
+        return if fields[key] == value # no-op
         @updated_keys << key
         fields[key] = value
       elsif column_mappings[key]
+        return if fields[column_mappings[key]] == value # no-op
         @updated_keys << column_mappings[key]
         fields[column_mappings[key]] = value
       else

data/lib/airrecord/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airrecord
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Simon Eskildsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-30 00:00:00.000000000 Z
+date: 2018-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Airtable client