Class: Airrecord::Table

Inherits:
Object
  • Object
show all
Defined in:
lib/airrecord/table.rb

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(fields, id: nil, created_at: nil) ⇒ Table

Returns a new instance of Table.



115
116
117
118
119
 
# File 'lib/airrecord/table.rb', line 115

def initialize(*one, **two)
  @id = one.first && two.delete(:id)
  self.created_at = one.first && two.delete(:created_at)
  self.fields = one.first || two
end

Class Attribute Details

.api_key ⇒ Object 



14
15
16
 
# File 'lib/airrecord/table.rb', line 14

def api_key
  defined?(@api_key) ? @api_key : Airrecord.api_key
end

.base_key ⇒ Object

Returns the value of attribute base_key.



6
7
8
 
# File 'lib/airrecord/table.rb', line 6

def base_key
  @base_key
end

.table_name ⇒ Object

Returns the value of attribute table_name.



6
7
8
 
# File 'lib/airrecord/table.rb', line 6

def table_name
  @table_name
end

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



110
111
112
 
# File 'lib/airrecord/table.rb', line 110

def created_at
  @created_at
end

#fields ⇒ Object

Returns the value of attribute fields.



110
111
112
 
# File 'lib/airrecord/table.rb', line 110

def fields
  @fields
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



110
111
112
 
# File 'lib/airrecord/table.rb', line 110

def id
  @id
end

#updated_keys ⇒ Object (readonly)

Returns the value of attribute updated_keys.



110
111
112
 
# File 'lib/airrecord/table.rb', line 110

def updated_keys
  @updated_keys
end

Class Method Details

.belongs_to(method_name, options) ⇒ Object Also known as: has_one 



34
35
36
 
# File 'lib/airrecord/table.rb', line 34

def belongs_to(method_name, options)
  has_many(method_name, options.merge(single: true))
end

.client ⇒ Object 



9
10
11
12
 
# File 'lib/airrecord/table.rb', line 9

def client
  @@clients ||= {}
  @@clients[api_key] ||= Client.new(api_key)
end

.create(fields, options = {}) ⇒ Object 



59
60
61
 
# File 'lib/airrecord/table.rb', line 59

def create(fields, options = {})
  new(fields).tap { |record| record.save(options) }
end

.find(id) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/airrecord/table.rb', line 40

def find(id)
  response = client.connection.get("/v0/#{base_key}/#{client.escape(table_name)}/#{id}")
  parsed_response = client.parse(response.body)

  if response.success?
    self.new(parsed_response["fields"], id: id, created_at: parsed_response["createdTime"])
  else
    client.handle_error(response.status, parsed_response)
  end
end

.find_many(ids) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/airrecord/table.rb', line 51

def find_many(ids)
  return [] if ids.empty?

  or_args = ids.map { |id| "RECORD_ID() = '#{id}'"}.join(',')
  formula = "OR(#{or_args})"
  records(filter: formula).sort_by { |record| or_args.index(record.id) }
end

.has_many(method_name, options) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/airrecord/table.rb', line 18

def has_many(method_name, options)
  define_method(method_name.to_sym) do
    # Get association ids in reverse order, because Airtable's UI and API
    # sort associations in opposite directions. We want to match the UI.
    ids = (self[options.fetch(:column)] || []).reverse
    table = Kernel.const_get(options.fetch(:class))
    return table.find_many(ids) unless options[:single]

    (id = ids.first) ? table.find(id) : nil
  end

  define_method("#{method_name}=".to_sym) do |value|
    self[options.fetch(:column)] = Array(value).map(&:id).reverse
  end
end

.records(filter: nil, sort: nil, view: nil, offset: nil, paginate: true, fields: nil, max_records: nil, page_size: nil) ⇒ Object Also known as: all 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/airrecord/table.rb', line 63

def records(filter: nil, sort: nil, view: nil, offset: nil, paginate: true, fields: nil, max_records: nil, page_size: nil)
  options = {}
  options[:filterByFormula] = filter if filter

  if sort
    options[:sort] = sort.map { |field, direction|
      { field: field.to_s, direction: direction }
    }
  end

  options[:view] = view if view
  options[:offset] = offset if offset
  options[:fields] = fields if fields
  options[:maxRecords] = max_records if max_records
  options[:pageSize] = page_size if page_size

  path = "/v0/#{base_key}/#{client.escape(table_name)}/listRecords"
  response = client.connection.post(path, options.to_json, { 'Content-Type' => 'application/json' })
  parsed_response = client.parse(response.body)

  if response.success?
    records = parsed_response["records"]
    records = records.map { |record|
      self.new(record["fields"], id: record["id"], created_at: record["createdTime"])
    }

    if paginate && parsed_response["offset"]
      records.concat(records(
        filter: filter,
        sort: sort,
        view: view,
        paginate: paginate,
        fields: fields,
        offset: parsed_response["offset"],
        max_records: max_records,
        page_size: page_size,
      ))
    end

    records
  else
    client.handle_error(response.status, parsed_response)
  end
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql? 



204
205
206
207
 
# File 'lib/airrecord/table.rb', line 204

def ==(other)
  self.class == other.class &&
    serializable_fields == other.serializable_fields
end

#[](key) ⇒ Object 



132
133
134
135
 
# File 'lib/airrecord/table.rb', line 132

def [](key)
  validate_key(key)
  fields[key]
end

#[]=(key, value) ⇒ Object 



137
138
139
140
141
142
143
 
# File 'lib/airrecord/table.rb', line 137

def []=(key, value)
  validate_key(key)
  return if fields[key] == value # no-op

  @updated_keys << key
  fields[key] = value
end

#create(options = {}) ⇒ Object

Raises:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/airrecord/table.rb', line 145

def create(options = {})
  raise Error, "Record already exists (record has an id)" unless new_record?

  body = {
    fields: serializable_fields,
    **options
  }.to_json

  response = client.connection.post("/v0/#{self.class.base_key}/#{client.escape(self.class.table_name)}", body, { 'Content-Type' => 'application/json' })
  parsed_response = client.parse(response.body)

  if response.success?
    @id = parsed_response["id"]
    self.created_at = parsed_response["createdTime"]
    self.fields = parsed_response["fields"]
  else
    client.handle_error(response.status, parsed_response)
  end
end

#destroy ⇒ Object

Raises:



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/airrecord/table.rb', line 187

def destroy
  raise Error, "Unable to destroy new record" if new_record?

  response = client.connection.delete("/v0/#{self.class.base_key}/#{client.escape(self.class.table_name)}/#{self.id}")
  parsed_response = client.parse(response.body)

  if response.success?
    true
  else
    client.handle_error(response.status, parsed_response)
  end
end

#hash ⇒ Object 



210
211
212
 
# File 'lib/airrecord/table.rb', line 210

def hash
  serializable_fields.hash
end

#new_record? ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
 
# File 'lib/airrecord/table.rb', line 128

def new_record?
  !id
end

#save(options = {}) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/airrecord/table.rb', line 165

def save(options = {})
  return create(options) if new_record?
  return true if @updated_keys.empty?

  # To avoid trying to update computed fields we *always* use PATCH
  body = {
    fields: Hash[@updated_keys.map { |key|
      [key, fields[key]]
    }],
    **options
  }.to_json

  response = client.connection.patch("/v0/#{self.class.base_key}/#{client.escape(self.class.table_name)}/#{self.id}", body, { 'Content-Type' => 'application/json' })
  parsed_response = client.parse(response.body)

  if response.success?
    self.fields = parsed_response["fields"]
  else
    client.handle_error(response.status, parsed_response)
  end
end

#serializable_fields ⇒ Object 



200
201
202
 
# File 'lib/airrecord/table.rb', line 200

def serializable_fields
  fields
end