windy 0.1.0 → 0.1.1

data/README.md

@@ -19,6 +19,10 @@ First off, install the Windy gem, and fire up your irb console.
     >> require 'rubygems'
     >> require 'windy'
 
+Note: The Socrata API is [rate-limited](http://dev.socrata.com/authentication) by default. If you would like to increase your quota, [register for an app token](http://dev.socrata.com/register) and pass it to Windy as follows:
+
+    >> Windy.app_token = "insert_your_app_token_here"
+
 ### 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.
@@ -28,7 +32,7 @@ To get an Array of all views:
     >> all_views = Windy.views
     >> all_views.count
     => 537
-    >> first_view = views.first
+    >> first_view = all_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).
 

data/lib/windy.rb

@@ -2,7 +2,19 @@ require 'faraday'
 require 'multi_json'
 
 module Windy
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
+
+  class << self
+    attr_accessor :app_token, :debug
+  end
+
+  class SocrataAppTokenMiddleware < Faraday::Middleware
+    def call(env)
+      raise "You must specify an app token" if !Windy.app_token
+      env[:request_headers]["X-App-Token"] = Windy.app_token
+      @app.call env
+    end
+  end
 
   class Base
     def self.root
@@ -12,7 +24,17 @@ module Windy
     attr_reader :connection
 
     def initialize
-      @connection = Faraday.new(:url => self.class.root)
+      @connection = Faraday.new(:url => self.class.root) do |builder|
+        builder.use SocrataAppTokenMiddleware
+        builder.request :json
+
+        # Enable logger output with Windy.debug = true
+        if Windy.debug
+          builder.response :logger
+        end
+
+        builder.adapter :net_http
+      end
     end
 
     def body
@@ -26,6 +48,9 @@ module Windy
     end
 
     def json
+      # For some reason ruby 1.9.x seems to be trying to parse the
+      # API JSON output as ASCII instead of UTF-8
+      body.force_encoding("UTF-8") unless body.nil?
       @json ||= MultiJson.decode(body)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: windy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,12 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-16 00:00:00.000000000 -05:00
-default_executable: 
+date: 2011-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70118986024880 !ruby/object:Gem::Requirement
+  requirement: &70259918929340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +22,10 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *70118986024880
+  version_requirements: *70259918929340
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70118986023900 !ruby/object:Gem::Requirement
+  requirement: &70259918928720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,7 +33,7 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70118986023900
+  version_requirements: *70259918928720
 description: Windy is a Ruby module that allows you to easily interact with the City
   of Chicago's Data Portal.
 email:
@@ -46,7 +45,6 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/windy.rb
-has_rdoc: true
 homepage: http://github.com/chicago/windy
 licenses: []
 post_install_message: 
@@ -67,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby interface to the City of Chicago's Data Portal API