dillo 0.1

data/README.md

@@ -0,0 +1,22 @@
+#Dillo
+
+Ruby library for working with the City of Austin [Data Portal](http://data.austintexas.gov).  This library is derived from [Windy](https://github.com/Chicago/windy) which is a library for interacting with Chicago's [Socrata](http://www.socrata.com) powered data portal.
+
+##Installing
+
+    $ gem install dillo
+
+##Future Plans
+
++ Full RDoc documentation
++ Rake tasks for running tests and misc.
++ More tests
++ Example applications
+
+##Issues
+
+Please use the issue tracker here on github.
+
+##Contributions
+
+Any contributions are welcome, there is not an specific requirements or standards being used at the moment.

data/lib/dillo.rb

@@ -0,0 +1,324 @@
+require 'faraday_middleware'
+require 'multi_json'
+
+module Dillo
+  VERSION = '0.1'
+
+  class << self
+    attr_accessor :app_token, :debug
+  end
+
+  module Response
+    class RaiseClientError < Faraday::Response::Middleware
+      def on_complete(env)
+        case env[:status].to_i
+          when 403
+            raise env[:response_headers][:x_error_message]
+        end
+      end
+    end
+  end
+
+  class SocrataAppTokenMiddleware < Faraday::Middleware
+    def call(env)
+      raise "You must specify an app token" if !Dillo.app_token
+      env[:request_headers]["X-App-Token"] = Dillo.app_token
+      @app.call env
+    end
+  end
+
+  class Base
+    def self.root
+      "http://data.austintexas.gov"
+    end
+
+    attr_reader :connection
+
+    def initialize
+      @connection = Faraday.new(:url => self.class.root) do |builder|
+        builder.use SocrataAppTokenMiddleware
+        builder.use Dillo::Response::RaiseClientError
+        builder.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
+
+        # Enable logger output with Dillojamie.phillips@austintexas.gov.debug = true
+        if Dillo.debug
+          builder.response :logger
+        end
+
+        builder.adapter :net_http
+      end
+    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
+      # 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? || !body.respond_to?(:force_encoding)
+      @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 = Dillo.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,128 @@
+--- !ruby/object:Gem::Specification
+name: dillo
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Jamie Phillips
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Dillo is a Ruby module that allows you to easily interact with the City
+  of Austin's Data Portal.
+email:
+- jamie.phillips@austintexas.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/dillo.rb
+homepage: http://github.com/phillipsj/dillo
+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.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby interface to the City of Austin's Data Portal API
+test_files: []