Project

mocrata

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Mode's SODA client
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
>= 0
>= 0
 Project Readme

Repo Status: Archived.

This repo was identified as an un-managed repository. As such, we have chosedn to decommission this repository to prevent the consumption of security vulnerabilities within this repository.

More info can be found here: https://mode.quip.com/NwvJAwA7l4SN/August-Issue-Review-Committee-Meeting#GYBACAb6dwZ

Mocrata

Build Status Code Climate Gem Version

Mocrata is a SODA (Socrata Open Data API) client developed by Mode Analytics.

Installation

Add this line to your application's Gemfile:

gem 'mocrata'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mocrata

Usage

Setup

Mocrata.configure do |config|
  config.app_token = 'yourtoken' # optional Socrata application token
end

Accessing data

dataset = Mocrata::Dataset.new("http://opendata.socrata.com/resource/mnkm-8ram")

dataset.name
=> "Country List ISO 3166 Codes Latitude Longitude"

dataset.csv_header
=> ["Country", "Alpha code", "Numeric code", "Latitude", "Longitude"]

dataset.csv
=> [["Albania", "AL", "8", "41", "20"],
    ["Algeria", "DZ", "12", "28", "3"], ...]

dataset.json
=> [{"longitude_average"=>"20",
     "latitude_average"=>"41",
     "alpha_2_code"=>"AL",
     "numeric_code"=>"8",
     "country"=>"Albania"}, ...]

dataset.fields
=> {":created_at"=>"meta_data", ":id"=>"meta_data", ":updated_at"=>"meta_data",
"alpha_2_code"=>"text", "country"=>"text", "latitude_average"=>"number",
"longitude_average"=>"number", "numeric_code"=>"number"}

Iterating through rows

dataset.each_row(:csv) do |row|
  # do something with the row
end

dataset.each_row(:json) { |row| ... }

Documentation

http://rubydoc.info/github/mode/mocrata/master/frames

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request