jsontableschema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1cf851281ccf698eb2f50ce29916e8b2632e841a
+  data.tar.gz: 253a669fbee44572cb3af3e9ed68592f444f08a1
+SHA512:
+  metadata.gz: 3215fdb1aa97951f83dc9f69484fc054befe9c9f0e9c8441692c011659fb5035bb8d41c42cd01863d8d474fd6f899caa48513d264872443e77961dd66f696635
+  data.tar.gz: 2cc35932e7a71d369e75c5818e979d2a6db0c0ad26217f856b98f663dba9bafc2f8fbb2a8516324dbd6209764bb5dce6a0f0e7a348077e31cf6c8c146b0fbee7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+language: ruby
+rvm:
+- 2.3.1
+before_install: gem install bundler -v 1.11.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: wH1kuoIanHWL0ohGKyFtcXDusgR5T5qD2QnaQS9vjIG6a//ClpYpDZ3iSxHG9CkkrbaKJDVhcGsKJOECcQRnLQ2/g9PC84c4tMzfgp3q5w7FdWfxe86diS3sXN4gw6+Xb+KhueOhO6RaghG1BJPBd2kj2G8uw6f/KT+8qOMaS+IRpuW8FkO7x8CZvUSLbzai21kYaneDglb5j/AY/sF2s+jGO/3VPmMjaJCJ7pU84Wqby6PixPMiP2EKVyhx1fD8m8CcPTAfPhiwxq1AkxxFJIkty730ECzwDVfrF9Ph5dcoR57jPliCSctNVREele2Q4ItBxi5Da5U3PiqHYu6AZR4pARoPMaO8m/ZwfvRftzwNDd7jnnkxLgWRRKDofU6wuxB+Jg8V7CbThTXyPFgn8RXYsL4tshOCCmicT8fbKO/f+S21gSQtQI1fZc6dc0WZqRCCY50NLnRH0eAJzXKfQxQ7iuKsF/nfGmZiAmVCZRKWVlGjQ+v5q5erXr+nS9prWotg/CrWiGhPkhHuEj8izBXxclzAuQHGE0H+IRwZFT/7Ym1KUKKhMx5mFRpf4EqLQ+mzIe8+4Ogn8YQclVP/3j14FtGCFiRegqy8SSfsKxTunF6i76Nbdj8v5Pkb0NZzvRjaBkbhvYKIAmLK1GaYC0lQS7gaqXqCRS64XjvAOGQ=
+  gem: jsontableschema
+  true:
+    tags: true
+    repo: theodi/jsontableschema.rb

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+## [v0.1.0](https://github.com/theodi/jsontableschema.rb/tree/v0.1.0) (2016-09-19)
+**Merged pull requests:**
+
+- Deploy stuff [\#8](https://github.com/theodi/jsontableschema.rb/pull/8) ([pezholio](https://github.com/pezholio))
+- Infer schema [\#7](https://github.com/theodi/jsontableschema.rb/pull/7) ([pezholio](https://github.com/pezholio))
+- Work with a table [\#6](https://github.com/theodi/jsontableschema.rb/pull/6) ([pezholio](https://github.com/pezholio))
+- Data conversion [\#5](https://github.com/theodi/jsontableschema.rb/pull/5) ([pezholio](https://github.com/pezholio))
+- Add constraints [\#4](https://github.com/theodi/jsontableschema.rb/pull/4) ([pezholio](https://github.com/pezholio))
+- Cast and validate types [\#3](https://github.com/theodi/jsontableschema.rb/pull/3) ([pezholio](https://github.com/pezholio))
+- Schema model [\#2](https://github.com/theodi/jsontableschema.rb/pull/2) ([pezholio](https://github.com/pezholio))
+- Validate a schema [\#1](https://github.com/theodi/jsontableschema.rb/pull/1) ([pezholio](https://github.com/pezholio))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at pezholio@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsontableschema.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 pezholio
+
+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

@@ -0,0 +1,233 @@
+[![Build Status](http://img.shields.io/travis/theodi/jsontableschema.rb.svg?style=flat-square)](https://travis-ci.org/theodi/jsontableschema.rb)
+[![Dependency Status](http://img.shields.io/gemnasium/theodi/jsontableschema.rb.svg?style=flat-square)](https://gemnasium.com/theodi/jsontableschema.rb)
+[![Coverage Status](https://coveralls.io/repos/github/theodi/jsontableschema.rb/badge.svg)](https://coveralls.io/github/theodi/jsontableschema.rb)
+[![Code Climate](http://img.shields.io/codeclimate/github/theodi/jsontableschema.rb.svg?style=flat-square)](https://codeclimate.com/github/theodi/jsontableschema.rb)
+[![Gem Version](http://img.shields.io/gem/v/jsontableschema.svg?style=flat-square)](https://rubygems.org/gems/jsontableschema)
+[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://theodi.mit-license.org)
+
+# JSON Table Schema
+
+A utility library for working with [JSON Table Schema](http://dataprotocols.org/json-table-schema/) in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsontableschema'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsontableschema
+
+## Usage
+
+### Parse a CSV
+
+Validate and cast data from a CSV as described by a schema.
+
+```ruby
+schema = {
+    "fields": [
+        {
+            "name" => "id",
+            "title" => "Identifier",
+            "type" => "integer"
+        },
+        {
+            "name" => "title",
+            "title" => "Title",
+            "type" => "string"
+        }
+    ]
+} # Can also be a URL or a path
+
+csv = 'https://github.com/theodi/jsontableschema.rb/raw/master/spec/fixtures/simple_data.csv' # Can also be a url or array of arrays
+
+table = JsonTableSchema::Table.new(csv, schema)
+table.rows
+#=> [[1,'foo'],[2,'bar'],[3,'baz']]
+```
+
+### Infer a schema
+
+If you don't have a schema for a CSV, and want to generate one, you can infer a schema like so:
+
+```ruby
+csv = 'https://github.com/theodi/jsontableschema.rb/raw/master/spec/fixtures/simple_data.csv' # Can also be a url or array of arrays
+
+table = JsonTableSchema::Table.infer_schema(csv)
+table.schema
+#=> {"fields"=>[{"name"=>"id", "title"=>"", "description"=>"", "type"=>"string", "format"=>"default"}, {"name"=>"title", "title"=>"", "description"=>"", "type"=>"string", "format"=>"default"}]}
+```
+
+### Validate a schema
+
+To validate that a schema meets the JSON Table Schema spec, you can pass a schema to the initializer like so:
+
+```ruby
+schema_hash = {
+  "fields" => [
+      {
+          "name" => "id"
+      },
+      {
+          "name" => "height"
+      }
+  ]
+}
+
+schema = JsonTableSchema::Schema.new(schema_hash)
+schema.valid?
+#=> true
+```
+
+You can also pass a file path or URL to the initializer:
+
+```ruby
+schema = JsonTableSchema::Schema.new('http://example.org/schema.json')
+schema.valid?
+#=> true
+```
+
+If the schema is invalid, you can access the errors via the `messages` attribute
+
+```ruby
+schema_hash = {
+  "fields" => [
+    {
+      "name"=>"id",
+      "title"=>"Identifier",
+      "type"=>"integer"
+   },
+   {
+     "name"=>"title",
+     "title"=>"Title",
+     "type"=>"string"
+    }
+  ],
+ "primaryKey"=>"identifier"
+}
+
+schema.valid?
+#=> false
+schema.messages
+#=> ["The JSON Table Schema primaryKey value `identifier` is not found in any of the schema's field names"]
+```
+
+## Schema Model
+
+You can also access the schema via a Ruby model, with some useful methods for interaction:
+
+```ruby
+schema_hash = {
+  "fields" => [
+      {
+          "name" => "id",
+          "type" => "string",
+          "constraints" => {
+            "required" => true,
+          }
+      },
+      {
+          "name" => "height",
+          "type" => "number"
+      }
+  ],
+  "primaryKey" => "id",
+  "foreignKeys" => [
+    {
+        "fields" => "state",
+        "reference" => {
+            "datapackage" => "http://data.okfn.org/data/mydatapackage/",
+            "resource" => "the-resource",
+            "fields" => "state_id"
+        }
+    }
+  ]
+}
+
+schema = JsonTableSchema::Schema.new(schema_hash)
+
+schema.headers
+#=> ["id", "height"]
+schema.required_headers
+#=> ["id"]
+schema.fields
+#=> [{"name"=>"id", "constraints"=>{"required"=>true}, "type"=>"string", "format"=>"default"}, {"name"=>"height", "type"=>"number", "format"=>"default"}]
+schema.primary_keys
+#=> ["id"]
+schema.foreign_keys
+#=> [{"fields" => "state", "reference" => { "datapackage" => "http://data.okfn.org/data/mydatapackage/", "resource" => "the-resource", "fields" => "state_id" } } ]
+schema.cast('height', '10')
+#=> 10.0
+schema.get_field('id')
+#=> {"name"=>"id", "constraints"=>{"required"=>true}, "type"=>"string", "format"=>"default"}
+schema.has_field?('foo')
+#=> false
+schema.get_type('id')
+#=> 'string'
+schema.get_fields_by_type('string')
+#=> [{"name"=>"id", "constraints"=>{"required"=>true}, "type"=>"string", "format"=>"default"}, {"name"=>"height", "type"=>"string", "format"=>"default"}]
+schema.get_constraints('id')
+#=> {"required" => true}
+schema.convert_row(['string', '10.0'])
+#=> ['string', 10.0]
+schema.convert([['foo', '12.0'],['bar', '10.0']])
+#=> [['foo', 12.0],['bar', 10.0]]
+```
+
+When converting a row (using `convert_row`), or a number of rows (using `convert`), by default the converter will fail on the first error it finds. If you pass `false` as the second argument, the errors will be collected into a `errors` attribute for you to review later. For example:
+
+```ruby
+schema_hash = {
+  "fields" => [
+      {
+          "name" => "id",
+          "type" => "string",
+          "constraints" => {
+            "required" => true,
+          }
+      },
+      {
+          "name" => "height",
+          "type" => "number"
+      }
+  ]
+}
+
+schema = JsonTableSchema::Schema.new(schema_hash)
+
+rows = [
+  ['foo', 'notanumber'],
+  ['bar', 'notanumber'],
+  ['wrong column count']
+]
+
+schema.convert(rows)
+#=> JsonTableSchema::InvalidCast: notanumber is not a number
+schema.convert(rows, false)
+#=> JsonTableSchema::MultipleInvalid
+schema.errors
+#=> [#<JsonTableSchema::InvalidCast: notanumber is not a number>, #<JsonTableSchema::InvalidCast: notanumber is not a number>, #<JsonTableSchema::ConversionError: The number of items to convert (1) does not match the number of headers in the schema (2)>]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jsontableschema. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jsontableschema"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/etc/schemas/geojson.json

@@ -0,0 +1,209 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "id": "https://raw.githubusercontent.com/fge/sample-json-schemas/master/geojson/geojson.json#",
+    "title": "Geo JSON object",
+    "description": "Schema for a Geo JSON object",
+    "type": "object",
+    "required": [ "type" ],
+    "properties": {
+        "crs": { "$ref": "#/definitions/crs" },
+        "bbox": { "$ref": "#/definitions/bbox" }
+    },
+    "oneOf": [
+        { "$ref": "#/definitions/geometry" },
+        { "$ref": "#/definitions/geometryCollection" },
+        { "$ref": "#/definitions/feature" },
+        { "$ref": "#/definitions/featureCollection" }
+    ],
+    "definitions": {
+        "geometryCollection": {
+            "title": "GeometryCollection",
+            "description": "A collection of geometry objects",
+            "required": [ "geometries" ],
+            "properties": {
+                "type": { "enum": [ "GeometryCollection" ] },
+                "geometries": {
+                    "type": "array",
+                    "items": { "$ref": "#/definitions/geometry" }
+                }
+            }
+        },
+        "feature": {
+            "title": "Feature",
+            "description": "A Geo JSON feature object",
+            "required": [ "geometry", "properties" ],
+            "properties": {
+                "type": { "enum": [ "Feature" ] },
+                "geometry": {
+                    "oneOf": [
+                        { "type": "null" },
+                        { "$ref": "#/definitions/geometry" }
+                    ]
+                },
+                "properties": { "type": [ "object", "null" ] },
+                "id": { "FIXME": "may be there, type not known (string? number?)" }
+            }
+        },
+        "featureCollection": {
+            "title": "FeatureCollection",
+            "description": "A Geo JSON feature collection",
+            "required": [ "features" ],
+            "properties": {
+                "type": { "enum": [ "FeatureCollection" ] },
+                "features": {
+                    "type": "array",
+                    "items": { "$ref": "#/definitions/feature" }
+                }
+            }
+        },
+        "geometry": {
+            "title": "geometry",
+            "description": "One geometry as defined by GeoJSON",
+            "type": "object",
+            "required": [ "type", "coordinates" ],
+            "oneOf": [
+                {
+                    "title": "Point",
+                    "properties": {
+                        "type": { "enum": [ "Point" ] },
+                        "coordinates": { "$ref": "#/definitions/geometry/definitions/position" }
+                    }
+                },
+                {
+                    "title": "MultiPoint",
+                    "properties": {
+                        "type": { "enum": [ "MultiPoint" ] },
+                        "coordinates": { "$ref": "#/definitions/geometry/definitions/positionArray" }
+                    }
+                },
+                {
+                    "title": "LineString",
+                    "properties": {
+                        "type": { "enum": [ "LineString" ] },
+                        "coordinates": { "$ref": "#/definitions/geometry/definitions/lineString" }
+                    }
+                },
+                {
+                    "title": "MultiLineString",
+                    "properties": {
+                        "type": { "enum": [ "MultiLineString" ] },
+                        "coordinates": {
+                            "type": "array",
+                            "items": { "$ref": "#/definitions/geometry/definitions/lineString" }
+                        }
+                    }
+                },
+                {
+                    "title": "Polygon",
+                    "properties": {
+                        "type": { "enum": [ "Polygon" ] },
+                        "coordinates": { "$ref": "#/definitions/geometry/definitions/polygon" }
+                    }
+                },
+                {
+                    "title": "MultiPolygon",
+                    "properties": {
+                        "type": { "enum": [ "MultiPolygon" ] },
+                        "coordinates": {
+                            "type": "array",
+                            "items": { "$ref": "#/definitions/geometry/definitions/polygon" }
+                        }
+                    }
+                }
+            ],
+            "definitions": {
+                "position": {
+                    "description": "A single position",
+                    "type": "array",
+                    "minItems": 2,
+                    "items": [ { "type": "number" }, { "type": "number" } ],
+                    "additionalItems": false
+                },
+                "positionArray": {
+                    "description": "An array of positions",
+                    "type": "array",
+                    "items": { "$ref": "#/definitions/geometry/definitions/position" }
+                },
+                "lineString": {
+                    "description": "An array of two or more positions",
+                    "allOf": [
+                        { "$ref": "#/definitions/geometry/definitions/positionArray" },
+                        { "minItems": 2 }
+                    ]
+                },
+                "linearRing": {
+                    "description": "An array of four positions where the first equals the last",
+                    "allOf": [
+                        { "$ref": "#/definitions/geometry/definitions/positionArray" },
+                        { "minItems": 4 }
+                    ]
+                },
+                "polygon": {
+                    "description": "An array of linear rings",
+                    "type": "array",
+                    "items": { "$ref": "#/definitions/geometry/definitions/linearRing" }
+                }
+            }
+        },
+        "crs": {
+            "title": "crs",
+            "description": "a Coordinate Reference System object",
+            "type": [ "object", "null" ],
+            "required": [ "type", "properties" ],
+            "properties": {
+                "type": { "type": "string" },
+                "properties": { "type": "object" }
+            },
+            "additionalProperties": false,
+            "oneOf": [
+                { "$ref": "#/definitions/crs/definitions/namedCrs" },
+                { "$ref": "#/definitions/crs/definitions/linkedCrs" }
+            ],
+            "definitions": {
+                "namedCrs": {
+                    "properties": {
+                        "type": { "enum": [ "name" ] },
+                        "properties": {
+                            "required": [ "name" ],
+                            "additionalProperties": false,
+                            "properties": {
+                                "name": {
+                                    "type": "string",
+                                    "FIXME": "semantic validation necessary"
+                                }
+                            }
+                        }
+                    }
+                },
+                "linkedObject": {
+                    "type": "object",
+                    "required": [ "href" ],
+                    "properties": {
+                        "href": {
+                            "type": "string",
+                            "format": "uri",
+                            "FIXME": "spec says \"dereferenceable\", cannot enforce that"
+                        },
+                        "type": {
+                            "type": "string",
+                            "description": "Suggested values: proj4, ogjwkt, esriwkt"
+                        }
+                    }
+                },
+                "linkedCrs": {
+                    "properties": {
+                        "type": { "enum": [ "link" ] },
+                        "properties": { "$ref": "#/definitions/crs/definitions/linkedObject" }
+                    }
+                }
+            }
+        },
+        "bbox": {
+            "description": "A bounding box as defined by GeoJSON",
+            "FIXME": "unenforceable constraint: even number of elements in array",
+            "type": "array",
+            "items": { "type": "number" }
+        }
+    }
+}
+