airrecord 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cb016c7f7bfa6d6e5affe3432faedf8cebf92a2
-  data.tar.gz: eff4bdb0fb4d85cbeaf2ca1dcf82f9c5523e6050
+  metadata.gz: 6488c3737cb574a3e1e5e1cbc1d5ae665482c364
+  data.tar.gz: 8ebba576595589c7d8e9c6558d9e2032d6953507
 SHA512:
-  metadata.gz: f2d60c1447b99e57037782bdd36ec9b93a058b5d0d713b10a8646cc41285d94ca4ccdced574d048b8c720c910fd4beeb020905e110df432b2f0062444e965f75
-  data.tar.gz: 3055b1ad8dd62efd1a28b07d11ace7e06b0411f082021f3ac6c5da7e1d0f986d84ca08874e2fcd8e217de21f1eec8025034216dc2e91739ee6fff73a418b4438
+  metadata.gz: 16a9ffc9fc7ec8a69061e7b26041410c3fcdba2bd2bb1b21f3034cc9f3f60a88dd0b8370118ed167595ba3e4a7aa51780987e74d6176d737736989c0c966fbb4
+  data.tar.gz: 998c84a7691409db02f09bb65479e7ebfe1e9a33b820dec3da333083751f4ca0031e892708e438dc63097bf4b39847c5b4143ccb631d3ed70ec76742996319a4

data/.gitignore

@@ -10,3 +10,4 @@
 vendor/
 test/fixtures
 .byebug_history
+*.gem

data/.travis.yml

@@ -1,5 +1,4 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.12.5
+  - 2.3.3

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2017 Simon Eskildsen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -9,6 +9,11 @@ inviting inspiration from ActiveRecord's API.
 gem 'airrecord'
 ```
 
+This library is provided to enforce a mental model of a database, as described
+in [this post](http://sirupsen.com/minimum-viable-airtable/). Furthermore as an
+alternative to the [official
+library](https://github.com/airtable/airtable-ruby).
+
 ## Examples
 
 There's a simple API that allows more ad-hoc querying of Airtable:
@@ -70,3 +75,10 @@ tea = Tea.find(tea.id)
 puts tea[:hot_brews].first[:rating]
 # => "3 - Fine"
 ```
+
+## Contributing
+
+Contributions will be happily accepted in the form of Github Pull Requests!
+
+* Please ensure CI is passing before submitting your pull request for review.
+* Please provide tests that fail without your change.

data/lib/airrecord/version.rb

@@ -1,3 +1,3 @@
 module Airrecord
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airrecord
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Simon Eskildsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2017-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -103,8 +103,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
-- ":w"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - airrecord.gemspec
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Airtable client

data/:w

@@ -1,341 +0,0 @@
-require 'securerandom'
-require 'test_helper'
-
-class AirtableTest < Minitest::Test
-  def setup
-    @table = Airtable.table("key6Zk9xjvoRQG1FO", "appxIxY6d7lz4yHZG", "table1")
-
-    @stubs = Faraday::Adapter::Test::Stubs.new
-    @table.client.connection = Faraday.new { |builder|
-      builder.adapter :test, @stubs
-    }
-
-    stub_request([{"Name": "omg", "Notes": "hello world", " Something  else\n" => "hi"}, {"Name": "more", "Notes": "walrus"}])
-  end
-
-  def test_retrieve_records
-    assert_instance_of Array, @table.records
-  end
-
-  def test_filter_records
-    stub_request([{"Name": "yes"}, {"Name": "no"}])
-
-    records = @table.records(filter: "Name")
-    assert_equal "yes", records[0][:name]
-  end
-
-  def test_sort_records
-    stub_request([{"Name": "a"}, {"Name": "b"}])
-
-    records = @table.records(sort: { Name: 'asc' })
-    assert_equal "a", records[0][:name]
-    assert_equal "b", records[1][:name]
-  end
-
-  def test_view_records
-    stub_request([{"Name": "a"}, {"Name": "a"}])
-
-    records = @table.records(view: 'A')
-    assert_equal "a", records[0][:name]
-    assert_equal "a", records[1][:name]
-  end
-
-  def test_follow_pagination_by_default
-    stub_request([{"Name": "1"}, {"Name": "2"}], offset: 'dasfuhiu')
-    stub_request([{"Name": "3"}, {"Name": "4"}], offset: 'odjafio', clear: false)
-    stub_request([{"Name": "5"}, {"Name": "6"}], clear: false)
-
-    records = @table.records
-    assert_equal 6, records.size
-  end
-
-  def test_dont_follow_pagination_if_disabled
-    stub_request([{"Name": "1"}, {"Name": "2"}], offset: 'dasfuhiu')
-    stub_request([{"Name": "3"}, {"Name": "4"}], offset: 'odjafio', clear: false)
-    stub_request([{"Name": "5"}, {"Name": "6"}], clear: false)
-
-    records = @table.records(paginate: false)
-    assert_equal 2, records.size
-  end
-
-  def test_index_by_normalized_name
-    assert_equal "omg", first_record[:name]
-  end
-
-  def test_index_by_column_name
-    assert_equal "omg", first_record["Name"]
-  end
-
-  def test_cleans_bad_keys
-    assert_equal "hi", first_record[:something_else]
-  end
-
-  def test_id
-    assert_instance_of String, first_record.id
-  end
-
-  def test_created_at
-    assert_instance_of Time, first_record.created_at
-  end
-
-  def test_error_response
-    stub_error_request(type: "TABLE_NOT_FOUND", message: "Could not find table", table: "unknown")
-
-    assert_raises Airtable::Error do
-      Airtable.table("key6Zk9xjvoRQG1FO", "appxIxY6d7lz4yHZG", "unknown").records
-    end
-  end
-
-  def test_change_value
-    record = first_record
-    record[:name] = "testest"
-    assert_equal "testest", record[:name]
-  end
-
-  def test_change_value_on_column_name
-    record = first_record
-    record["Name"] = "testest"
-    assert_equal "testest", record[:name]
-  end
-
-  def test_change_value_and_update
-    record = first_record
-
-    record[:name] = "new_name"
-    stub_patch_request(record, ["Name"])
-
-    assert record.save
-  end
-
-  def test_change_value_then_save_again_should_noop
-    record = first_record
-
-    record[:name] = "new_name"
-    stub_patch_request(record, ["Name"])
-
-    assert record.save
-    assert record.save
-  end
-
-  def test_updates_fields_to_newest_values_after_update
-    record = first_record
-
-    record[:name] = "new_name"
-    stub_patch_request(record, ["Name"], return_body: record.fields.merge("Notes" => "new animal"))
-
-    assert record.save
-    assert_equal "new_name", record[:name]
-    assert_equal "new animal", record[:notes]
-  end
-
-  def test_update_failure
-    record = first_record
-
-    record[:name] = "new_name"
-    stub_patch_request(record, ["Name"], return_body: { error: { type: "oh noes", message: 'yes' } }, status: 401)
-
-    assert_raises Airtable::Error do
-      record.save
-    end
-  end
-
-  def test_update_failure_then_succeed
-    record = first_record
-
-    record[:name] = "new_name"
-    stub_patch_request(record, ["Name"], return_body: { error: { type: "oh noes", message: 'yes' } }, status: 401)
-
-    assert_raises Airtable::Error do
-      record.save
-    end
-
-    stub_patch_request(record, ["Name"])
-    assert record.save
-  end
-
-  def test_update_raises_if_new_record
-    record = @table.build_record(Name: "omg")
-
-    assert_raises Airtable::Error do
-      record.save
-    end
-  end
-
-  def test_existing_record_is_not_new
-    refute first_record.new_record?
-  end
-
-  def test_build_new_record
-    record = @table.build_record(Name: "omg")
-
-    refute record.id
-    refute record.created_at
-    assert record.new_record?
-  end
-
-  def test_create_new_record
-    record = @table.build_record(Name: "omg")
-
-    stub_post_request(record)
-
-    assert record.create
-  end
-
-  def test_create_existing_record_fails
-    record = @table.build_record(Name: "omg")
-
-    stub_post_request(record)
-
-    assert record.create
-
-    assert_raises Airtable::Error do
-      record.create
-    end
-  end
-
-  def test_create_handles_error
-    record = @table.build_record(Name: "omg")
-
-    stub_post_request(record, status: 401, return_body: { error: { type: "omg", message: "wow" }})
-
-    assert_raises Airtable::Error do
-      record.create
-    end
-  end
-
-  def test_find
-    record = @table.build_record(Name: "walrus")
-
-    stub_find_request(record, id: "iodfajsofja")
-
-    record = @table.find("iodfajsofja")
-    assert_equal "walrus", record[:name]
-  end
-
-  def test_find_handles_error
-    stub_find_request(nil, return_body: { error: { type: "not found", message: "not found" } }, id: "noep", status: 404)
-
-    assert_raises Airtable::Error do
-      @table.find("noep")
-    end
-  end
-
-  def test_destroy_new_record_fails
-    record = @table.build_record(Name: "walrus")
-
-    assert_raises Airtable::Error do
-      record.destroy
-    end
-  end
-
-  def test_destroy_record
-    record = first_record
-    stub_delete_request(record.id)
-    assert record.destroy
-  end
-
-  def test_fail_destroy_record
-    record = first_record
-    stub_delete_request(record.id, status: 404, response_body: { error: { type: "not found", message: "whatever" } }.to_json)
-
-    assert_raises Airtable::Error do
-      record.destroy
-    end
-  end
-
-  def test_error_handles_errors_without_body
-    record = first_record
-
-    stub_delete_request(record.id, status: 500)
-
-    assert_raises Airtable::Error do
-      record.destroy
-    end
-  end
-
-  private
-
-  def first_record
-    @table.records.first
-  end
-
-  def stub_delete_request(id, table: @table, status: 202, response_body: "")
-    @stubs.delete("/v0/#{@table.base_key}/#{@table.table_name}/#{id}") do |env|
-      [status, {}, response_body]
-    end
-  end
-
-  def stub_post_request(record, table: @table, status: 200, headers: {}, return_body: nil)
-    return_body ||= {
-      id: SecureRandom.hex(16),
-      fields: record.fields,
-      createdTime: Time.now,
-    }
-    return_body = return_body.to_json
-
-    request_body = { fields: record.fields }.to_json
-
-    @stubs.post("/v0/#{@table.base_key}/#{@table.table_name}", request_body) do |env|
-      [status, headers, return_body]
-    end
-  end
-
-  def stub_patch_request(record, updated_keys, table: @table1, status: 200, headers: {}, return_body: nil)
-    return_body ||= record.fields
-    return_body = return_body.to_json
-
-    request_body = {
-      fields: Hash[updated_keys.map { |key|
-        [key, record.fields[key]]
-      }]
-    }.to_json
-
-    @stubs.patch("/v0/#{@table.base_key}/#{@table.table_name}/#{record.id}", request_body) do |env|
-      [status, headers, return_body]
-    end
-  end
-
-  # TODO: Problem, can't stub on params.
-  def stub_request(records, table: @table, status: 200, headers: {}, offset: nil, clear: true)
-    @stubs.instance_variable_set(:@stack, {}) if clear
-
-    body = {
-      records: records.map { |record|
-        {
-          id: SecureRandom.hex(16),
-          fields: record,
-          createdTime: Time.now,
-        }
-      },
-      offset: offset,
-    }.to_json
-
-    @stubs.get("/v0/#{@table.base_key}/#{@table.table_name}") do |env|
-      [status, headers, body]
-    end
-  end
-
-  def stub_find_request(record = nil, table: @table, status: 200, headers: {}, return_body: nil, id: nil)
-    return_body ||= record.fields
-    return_body = return_body.to_json
-
-    id ||= record.id
-
-    @stubs.get("/v0/#{@table.base_key}/#{@table.table_name}/#{id}") do |env|
-      [status, headers, return_body]
-    end
-  end
-
-  def stub_error_request(type:, message:, status: 401, headers: {}, table: @table)
-    body = {
-      error: {
-        type: type,
-        message: message,
-      }
-    }.to_json
-
-    @stubs.get("/v0/#{@table.base_key}/#{@table.table_name}") do |env|
-      [status, headers, body]
-    end
-  end
-end