windy 0.1.0

data/README.md

@@ -0,0 +1,73 @@
+Windy
+====================
+
+Windy is a Ruby module that allows you to easily interact with the [City of Chicago's Data Portal](http://data.cityofchicago.org/).
+
+The city's datasets are hosted using the [Socrata](http://www.socrata.com/) software platform. This library serves as a convenience wrapper to interacting with [Socrata's Open Data API](http://dev.socrata.com/).
+
+How to use
+--------------------
+
+Before we begin, it should be noted that there are several ways to interact with the City of Chicago's datasets. You can download the data, play with it using the Visualize or Filter functions on the city's website or query the datasets live using Socrata's API. Windy was created to assist with the third type of interaction: querying the live datasets.
+
+We'll walk through a few steps below, and show you what Windy can do.
+
+First off, install the Windy gem, and fire up your irb console.
+
+    $ gem install windy
+    $ irb
+    >> require 'rubygems'
+    >> require 'windy'
+
+### Views
+
+Views are at the heart of each dataset. In a nutshell, every dataset has at least one view, the original view. Users of the Data Portal are allowed to create customized views, however for the sake of this walk-through, we'll only be discussing the original view.
+
+To get an Array of all views:
+
+    >> all_views = Windy.views
+    >> all_views.count
+    => 537
+    >> first_view = views.first
+
+If you know which view you'd like to work with, you can access it directly by the View ID. In the following example, we found the the View's ID by looking at the end of the [Towed Vehicle's dataset URL](http://data.cityofchicago.org/Government/Towed-Vehicles/ygr5-vcbg).
+
+    >> towed_vehicles = Windy.views.find_by_id("ygr5-vcbg")
+
+Or, if you'd like to search for a view by name:
+
+    >> bike_racks = Windy.views.find_by_name("Bike Racks")
+
+### Rows
+
+Much like a spreadsheet, each view contains a number of rows. These, too , can be accessed using Windy.
+
+    >> racks = bike_racks.rows
+
+We can see which columns exists for these rows.
+
+    >> racks.columns
+    => ["sid", "id", "position", "created_at", "created_meta", "updated_at", "updated_meta", "meta", "rackid", "address", "ward", "community area", "community name", "totinstall", "latitude", "longitude", "historical", "f12", "f13", "location", "tags"]
+
+We can search for rows based on column names. Just use the convenient "find_by_columnname" method:
+
+    >> first_ward_racks = racks.find_all_by_ward("1")
+    >> lake_view_racks = racks.find_all_by_community_name("Lake View")
+
+And, find values for a specific row's cell.
+
+    >> first_rack = lake_view_racks.first
+    >> first_rack.address
+    => "1000 W Addison St"
+
+Authors
+--------------------
+
+* Sam Stephenson <<sstephenson@gmail.com>>
+* Scott Robbin <<srobbin@gmail.com>>
+
+<a rel="license" href="http://creativecommons.org/publicdomain/zero/1.0/">
+  <img src="http://i.creativecommons.org/p/zero/1.0/88x31.png" style="border-style: none;" alt="CC0" />
+</a>
+
+To the extent possible under law, the authors have waived all copyright and related or neighboring rights to this work.

data/lib/windy.rb

@@ -0,0 +1,287 @@
+require 'faraday'
+require 'multi_json'
+
+module Windy
+  VERSION = '0.1.0'
+
+  class Base
+    def self.root
+      "http://data.cityofchicago.org"
+    end
+
+    attr_reader :connection
+
+    def initialize
+      @connection = Faraday.new(:url => self.class.root)
+    end
+
+    def body
+      @body ||= connection.get(path) do |request|
+        prepare_request(request)
+        # warn "Fetching #{request.to_env(@connection)[:url]}"
+      end.body
+    end
+
+    def prepare_request(request)
+    end
+
+    def json
+      @json ||= MultiJson.decode(body)
+    end
+
+    def inspect
+      "#<#{self.class.name} #{self.class.root}#{path}>"
+    end
+  end
+
+  module Finders
+    def [](index)
+      to_a[index]
+    end
+
+    def respond_to?(method)
+      method.to_s[/^find(_all)?_by_./] || super
+    end
+
+    def method_missing(method, *args, &block)
+      if attribute = method.to_s[/^(find(_all)?)_by_(.+)$/, 3]
+        value = args.first
+        send($1) { |record| record.send(attribute) == value }
+      else
+        super
+      end
+    end
+  end
+
+  class PaginatedCollection < Base
+    include Enumerable, Finders
+
+    def initialize
+      @pages ||= {}
+    end
+
+    def page(number)
+      @pages[number] ||= Page.new(self, number)
+    end
+
+    def each_page
+      number = 1
+      loop do
+        page = self.page(number)
+        break if page.count.zero?
+        yield page
+        number += 1
+      end
+    end
+
+    def each(&block)
+      each_page do |page|
+        page.each(&block)
+      end
+    end
+  end
+
+  class Collection < Base
+    include Enumerable, Finders
+
+    def each(&block)
+      records.each(&block)
+    end
+
+    def record_attributes
+      json
+    end
+
+    def records
+      @records ||= record_attributes.map do |attributes|
+        create_record(attributes)
+      end
+    end
+
+    def create_record(attributes)
+      record_class.new(attributes)
+    end
+  end
+
+  class Page < Collection
+    attr_accessor :collection, :number
+
+    def initialize(collection, number)
+      @collection = collection
+      @number = number
+      super()
+    end
+
+    def path
+      collection.path
+    end
+
+    def record_class
+      collection.record_class
+    end
+
+    def prepare_request(request)
+      request.params['limit'] = 200
+      request.params['page'] = @number
+    end
+  end
+
+  class Record
+    undef_method(:id) if method_defined?(:id)
+
+    attr_reader :attributes
+
+    def initialize(attributes)
+      self.attributes = attributes
+    end
+
+    def attributes=(attributes)
+      @attributes = Windy.underscore(attributes)
+    end
+
+    def respond_to?(method)
+      @attributes.has_key?(method.to_s) || super
+    end
+
+    def method_missing(method, *args, &block)
+      if respond_to?(method)
+        @attributes[method.to_s]
+      else
+        super
+      end
+    end
+
+    def inspect
+      "#<#{self.class.name}:#{id}>"
+    end
+  end
+
+  class Views < PaginatedCollection
+    def path
+      "/api/views"
+    end
+
+    def record_class
+      View
+    end
+  end
+
+  class View < Record
+    def columns
+      @columns ||= Columns.new(id)
+    end
+
+    def rows
+      @rows ||= Rows.new(id)
+    end
+
+    def inspect
+      super[0..-2] + " #{name.inspect}>"
+    end
+  end
+
+  class Columns < Collection
+    def initialize(id)
+      @id = id
+      super()
+    end
+
+    def path
+      "/api/views/#{@id}/columns.json"
+    end
+
+    def record_class
+      Column
+    end
+  end
+
+  class Column < Record
+    def inspect
+      "#<#{self.class.name}:#{id} #{name.inspect}>"
+    end
+  end
+
+  class Rows < Collection
+    def initialize(id)
+      @id = id
+      super()
+    end
+
+    def path
+      "/api/views/#{@id}/rows.json"
+    end
+
+    def record_class
+      Row
+    end
+
+    def record_attributes
+      json['data']
+    end
+
+    def columns
+      @columns ||= json['meta']['view']['columns'].map { |column| column['name'].downcase }
+    end
+
+    def column_index(name)
+      columns.index(name.to_s.downcase)
+    end
+
+    def create_record(attributes)
+      record_class.new(self, attributes)
+    end
+  end
+
+  class Row
+    undef_method(:id) if method_defined?(:id)
+
+    attr_reader :collection, :values
+
+    def initialize(collection, values)
+      @collection = collection
+      @values = values
+    end
+
+    def [](index_or_name)
+      if index_or_name.is_a?(Integer)
+        values[index_or_name]
+      elsif index = collection.column_index(index_or_name)
+        values[index]
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      name = method.to_s.gsub('_', ' ')
+      if collection.column_index(name)
+        self[name]
+      else
+        super
+      end
+    end
+
+    def length
+      values.length
+    end
+
+    def to_a
+      values
+    end
+
+    def inspect
+      "#<#{self.class.name} #{values.inspect}>"
+    end
+  end
+
+  def self.views
+    @views ||= Views.new
+  end
+
+  def self.underscore(hash)
+    Hash.new.tap do |result|
+      hash.each do |original_key, value|
+        new_key = original_key.gsub(/([a-z])([A-Z])/) { "#{$1}_#{$2.downcase}" }
+        result[new_key] = value.is_a?(Hash) ? underscore(value) : value
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: windy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sam Stephenson
+- Scott Robbin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-16 00:00:00.000000000 -05:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70118986024880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70118986024880
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70118986023900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70118986023900
+description: Windy is a Ruby module that allows you to easily interact with the City
+  of Chicago's Data Portal.
+email:
+- sstephenson@gmail.com
+- srobbin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/windy.rb
+has_rdoc: true
+homepage: http://github.com/chicago/windy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby interface to the City of Chicago's Data Portal API
+test_files: []