airtable 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f786a63741240706eedfbab84efc45ed49519a5d
-  data.tar.gz: 5c40878d599f0aa5d87a4e7c418900c4c58967d0
+  metadata.gz: eb153e06bee46ce7fdf9e4dff38f865c4d0b06f7
+  data.tar.gz: f484c60556d41073e7ef37875d7055ce927bf58d
 SHA512:
-  metadata.gz: fa8df8e7bc785c82774a3b6657db936024f361bb08f3806c9349a0248df8aaba154b7b7def6064e6b69ba66fde2be95ad2b23de38e9cb70a169a94b8b2476b40
-  data.tar.gz: 223305632268c83d5d2687f195ec7d2f517add7931146b2dd8ad60c8479a7877c5b6f06b737c2cae6168ffa3320a248a2ad5b249f7d97d02c54f4960a1eafb8a
+  metadata.gz: f015c413e7e65127f41be7512ac6d2eb57d3a8a1f4f0a6e17deea2cf96926534236e14827b03e008f781c1edaedd0c6c9ce93a644bd2dec3a0c3180545c2d7eb
+  data.tar.gz: 471dc50590a47da27667d0beb47b8fc0c58113d33482d74b4621497c5d41106c00c537a3f0e4344373bc01de2661a021ef0d6c74a9ce5b3f30731adc127bd8be

data/LICENSE.txt

@@ -1,4 +1,5 @@
 Copyright (c) 2015 Nathan Esquenazi
+Copyright (c) 2016 Airtable
 
 MIT License
 

data/README.md

@@ -2,6 +2,14 @@
 
 Easily connect to [airtable](https://airtable.com) data using ruby with access to all of the airtable features.
 
+# Note on library status
+
+We are currently transitioning this gem to be supported by
+Airtable. We will maintain it moving forward, but until we fully
+support it, it will stay in the status of "community libraries". At
+that time we will remove this notice and add a "ruby" section to the
+API docs.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -74,7 +82,7 @@ We can also query all records in the table through a series of batch requests wi
 @records = @table.all(:sort => ["Name", :asc])
 ```
 
-This executes a variable number of network requests (100 records per batch) to retrieve all records in a sheet. 
+This executes a variable number of network requests (100 records per batch) to retrieve all records in a sheet.
 
 ### Finding a Record
 
@@ -107,7 +115,7 @@ Records can be updated using the `update` method on a table:
 
 ### Deleting Records
 
-Records can be updated using the `update` method on a table:
+Records can be destroyed using the `destroy` method on a table:
 
 ```ruby
 @table.destroy(record)

data/airtable.gemspec

@@ -6,8 +6,8 @@ require 'airtable/version'
 Gem::Specification.new do |spec|
   spec.name          = "airtable"
   spec.version       = Airtable::VERSION
-  spec.authors       = ["Nathan Esquenazi"]
-  spec.email         = ["nesquena@gmail.com"]
+  spec.authors       = ["Nathan Esquenazi", "Alexander Sorokin"]
+  spec.email         = ["nesquena@gmail.com", "syrnick@gmail.com"]
   spec.summary       = %q{Easily connect to airtable data using ruby}
   spec.description   = %q{Easily connect to airtable data using ruby with access to all of the airtable features.}
   spec.homepage      = "https://github.com/nesquena/airtable-ruby"

data/lib/airtable/table.rb

@@ -27,6 +27,28 @@ module Airtable
       RecordSet.new(results)
     end
 
+    # Query for records using a string formula
+    # Options: limit = 100, offset = "as345g", sort = ["Name", "asc"],
+    #          fields = [Name, Email], formula = "Count > 5", view = "Main View"
+    #
+    # select(limit: 10, sort: ["Name", "asc"], formula: "Order < 2")
+    def select(options={})
+      options['sortField'], options['sortDirection'] = options.delete(:sort) if options[:sort]
+      options['maxRecords'] = options.delete(:limit) if options[:limit]
+
+      if options[:formula]
+        raise_bad_formula_error unless options[:formula].is_a? String
+        options['filterByFormula'] = options.delete(:formula)
+      end
+
+      results = self.class.get(worksheet_url, query: options).parsed_response
+      RecordSet.new(results)
+    end
+
+    def raise_bad_formula_error
+      raise ArgumentError.new("The value for filter should be a String.")
+    end
+
     # Returns record based given row id
     def find(id)
       result = self.class.get(worksheet_url + "/" + id).parsed_response
@@ -59,6 +81,17 @@ module Airtable
       end
     end
 
+    def update_record_fields(record_id, fields_for_update)
+      result = self.class.patch(worksheet_url + "/" + record_id,
+        :body => { "fields" => fields_for_update }.to_json,
+        :headers => { "Content-type" => "application/json" }).parsed_response
+      if result.present? && result["id"].present?
+        Record.new(result_attributes(result))
+      else # failed
+        false
+      end
+    end
+
     # Deletes record in table based on id
     def destroy(id)
       self.class.delete(worksheet_url + "/" + id).parsed_response
@@ -71,8 +104,8 @@ module Airtable
     end
 
     def worksheet_url
-      "/#{app_token}/#{URI.encode(worksheet_name)}"
+      "/#{app_token}/#{CGI.escape(worksheet_name)}"
     end
   end # Table
 
-end # Airtable
+end # Airtable

data/lib/airtable/version.rb

@@ -1,3 +1,3 @@
 module Airtable
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/test/airtable_test.rb

@@ -22,6 +22,22 @@ describe Airtable do
       assert_equal "abcde", @records.offset
     end
 
+    it "should select records based on a formula" do
+      query_str = "OR(RECORD_ID() = 'recXYZ1', RECORD_ID() = 'recXYZ2', RECORD_ID() = 'recXYZ3', RECORD_ID() = 'recXYZ4')"
+      escaped_query = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER.call(filterByFormula: query_str)
+      request_url = "https://api.airtable.com/v0/#{@app_key}/#{@sheet_name}?#{escaped_query}"
+      stub_airtable_response!(request_url, { "records" => []})
+      @table = Airtable::Client.new(@client_key).table(@app_key, @sheet_name)
+      @select_records = @table.select(formula: query_str)
+      assert_equal @select_records.records, []
+    end
+
+    it "should raise an ArgumentError if a formula is not a string" do
+      stub_airtable_response!("https://api.airtable.com/v0/#{@app_key}/#{@sheet_name}", { "records" => [], "offset" => "abcde" })
+      @table = Airtable::Client.new(@client_key).table(@app_key, @sheet_name)
+      proc {  @table.select(formula: {foo: 'bar'}) }.must_raise ArgumentError
+    end
+
     it "should allow creating records" do
       stub_airtable_response!("https://api.airtable.com/v0/#{@app_key}/#{@sheet_name}",
         { "fields" => { "name" => "Sarah Jaine", "email" => "sarah@jaine.com", "foo" => "bar" }, "id" => "12345" }, :post)
@@ -44,4 +60,4 @@ describe Airtable do
     end
 
   end # describe Airtable
-end # Airtable
+end # Airtable

metadata

@@ -1,108 +1,110 @@
 --- !ruby/object:Gem::Specification
 name: airtable
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Nathan Esquenazi
+- Alexander Sorokin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   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: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.6.0
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Easily connect to airtable data using ruby with access to all of the
   airtable features.
 email:
 - nesquena@gmail.com
+- syrnick@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -128,17 +130,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Easily connect to airtable data using ruby