mocrata 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ea5004761040d9a269f778003915705495aeb80
-  data.tar.gz: 29f11a520caf96642656e6e0268b643f3d284cae
+  metadata.gz: fc529931b56e0de47b1a4ade8a83c05e4dc31b7e
+  data.tar.gz: c28c9d3d688b4129694fbf20c96d52168b1889e7
 SHA512:
-  metadata.gz: d887cafd67ad5669aa6560c169eba34464db314df0763ebbc5dd697b22bf2b32d5f0312dc192d8323e9630cea1d1b03c420f33934fa08a855dab19792639820f
-  data.tar.gz: 6ac06af00a4d45b148edd57adabf239f2d26e653f1ded892f9b36acd82ad99d94631858f3d7a6d6d20e6593880ff83120b1f27d2a917dcac8e5322b4169b1bc3
+  metadata.gz: 2a8e8142718c0b96126f2975e7108463667ce9a679b65fdab7ed1fe55c0c6f9915e5c53e088a5e1aab085c3f80cd3d2bda59c0819640e1f251b5a71c58093d9a
+  data.tar.gz: 2787a4131eabc7ee3fc12a612d03b4228fc2623a092f4d976bbbd971e2dee59ba6720f12659bc34d35ac064583c2fbbd51e31ae4551f5f10042b46dff10b6e10

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/README.md

@@ -1,5 +1,9 @@
 # Mocrata
 
+[![Build Status](https://travis-ci.org/mode/mocrata.svg?branch=master)](https://travis-ci.org/mode/mocrata)
+[![Code Climate](https://codeclimate.com/repos/53d16a75695680764e01ea68/badges/c93756788e4438e90512/gpa.png)](https://codeclimate.com/repos/53d16a75695680764e01ea68/feed)
+[![Gem Version](https://badge.fury.io/rb/mocrata.svg)](http://badge.fury.io/rb/mocrata)
+
 Mocrata is a [SODA](http://dev.socrata.com/) (Socrata Open Data API) client
 developed by [Mode Analytics](https://modeanalytics.com).
 
@@ -30,16 +34,29 @@ end
 ### Accessing data
 
 ```
-dataset = Mocrata::Dataset.new('http://soda.demo.socrata.com/resource/6xzm-fzcu')
+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
-=> [["Sally", 10], ["Earl", 2]]
+=> [["Albania", "AL", "8", "41", "20"],
+    ["Algeria", "DZ", "12", "28", "3"], ...]
 
 dataset.json
-=> [{"name"=>"Sally", "age"=>10}, {"name"=>"Earl", "age"=>2}]
+=> [{"longitude_average"=>"20",
+     "latitude_average"=>"41",
+     "alpha_2_code"=>"AL",
+     "numeric_code"=>"8",
+     "country"=>"Albania"}, ...]
 
 dataset.fields
-=> {"name"=>"text", "age"=>"number"}
+=> {":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
@@ -52,6 +69,10 @@ end
 dataset.each_row(:json) { |row| ... }
 ```
 
+## Documentation
+
+http://rubydoc.info/github/mode/mocrata/master/frames
+
 ## Contributing
 
 1. Fork it

data/Rakefile

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

data/lib/mocrata.rb

@@ -12,7 +12,8 @@ module Mocrata
   #
   CONTENT_TYPES = {
     :json => 'application/json',
-    :csv  => 'text/csv'
+    :csv  => 'text/csv',
+    :xml  => 'application/atom+xml'
   }
 
   class << self

data/lib/mocrata/dataset.rb

@@ -7,20 +7,21 @@ module Mocrata
   class Dataset
     # Construct a new Dataset instance
     #
-    # @param url [String] valid {http://dev.socrata.com SODA} resource url
+    # @param original_url [String] valid {http://dev.socrata.com SODA} resource
+    #   url
     #
     # @return [Mocrata::Dataset] the instance
     #
     # @example
     #   dataset = Mocrata::Dataset.new('http://data.sfgov.org/resource/funx-qxxn')
     #
-    def initialize(url)
-      @url = url
+    def initialize(original_url)
+      @original_url = original_url
     end
 
     # Iterate through each row of the dataset
     #
-    # @param format [Symbol, String] the format, `:json` or `:csv`
+    # @param format [optional, Symbol] the format, `:json` or `:csv`
     #
     # @yield [Array<Array>] row of values
     #
@@ -29,7 +30,7 @@ module Mocrata
     #     # do something with the row
     #   end
     #
-    def each_row(format, &block)
+    def each_row(format = :json, &block)
       each_page(format) do |page|
         page.each(&block)
       end
@@ -37,8 +38,12 @@ module Mocrata
 
     # Iterate through each page of the dataset
     #
-    # @param format [Symbol, String] the format, `:json` or `:csv`
-    # @param per_page [optional, Integer] the number of rows to return for each page
+    # @param format [optional, Symbol] the format, `:json` or `:csv`
+    # @param options [optional, Hash] hash of options
+    #
+    # @option options [Integer] :per_page the number of rows to return for each
+    #   page
+    # @option options [Integer] :page the first page
     #
     # @yield [Array<Array>] page of rows
     #
@@ -47,56 +52,63 @@ module Mocrata
     #     # do something with the page
     #   end
     #
-    def each_page(format, per_page = nil, &block)
-      page       = 1
-      per_page ||= Mocrata.config.per_page
+    def each_page(format = :json, options = {}, &block)
+      page     = options.fetch(:page, 1)
+      per_page = options.fetch(:per_page, Mocrata.config.per_page)
 
       while true
-        rows = send(format, :page => page, :per_page => per_page)
+        rows = get(format, :page => page, :per_page => per_page).body
         yield rows
         break if rows.size < per_page
         page += 1
       end
     end
 
-    # The contents of the dataset in CSV format
-    #
-    # @param params [optional, Hash] hash of options to pass along to the HTTP request
-    #
-    # @option params [Integer] :page the page to request
-    # @option params [Integer] :per_page the number of rows to return for each page
+    # All rows in the dataset
     #
-    # @return [Array<Array>] the array of rows
+    # @param format [optional, Symbol] the format, `:json` or `:csv`
     #
-    # @example
-    #   dataset.csv(:page => 2, :per_page => 10)
+    # @return [Array] all rows in the requested format
     #
-    def csv(params = {})
-      get(:csv, params).body
+    def rows(format = :json)
+      rows = []
+      each_page(format) { |page| rows += page }
+      rows
     end
 
     # The contents of the dataset in JSON format
     #
-    # @param params [optional, Hash] hash of options to pass along to the HTTP request
+    # @return [Array<Hash>] the array of rows
     #
-    # @option params [Integer] :page the page to request
-    # @option params [Integer] :per_page the number of rows to return for each page
+    def json
+      rows(:json)
+    end
+
+    # The contents of the dataset in CSV format
     #
-    # @return [Array<Hash>] the array of rows
+    # @return [Array<Array>] the array of rows
     #
-    # @example
-    #   dataset.json(:page => 2, :per_page => 10)
+    def csv
+      rows(:csv)
+    end
+
+    # The parsed header of the dataset in CSV format
     #
-    def json(params = {})
-      get(:json, params).body
+    # @return [Array<String>] the array of headers
+    #
+    def csv_header
+      options = { :paginate => false, :preserve_header => true }
+      params  = { :limit => 0 }
+
+      Mocrata::Request.new(resource_url, :csv, options, params).response.body[0]
     end
 
-    # Get the headers associated with the dataset
+    # Get the HTTP headers associated with the dataset (SODA doesn't support
+    #   HEAD requests)
     #
     # @return [Hash] a hash of headers
     #
     def headers
-      # SODA doesn't support HEAD requests, unfortunately
       @headers ||= get(:json, :per_page => 0).headers
     end
 
@@ -108,16 +120,40 @@ module Mocrata
       Hash[field_names.zip(field_types)]
     end
 
+    # A parsed representation of the dataset's {http://www.odata.org OData}
+    #
+    # @return [REXML::Document] a parsed REXML document
+    #
+    def odata
+      @odata ||= Mocrata::Request.new(odata_url, :xml, :top => 0).response.body
+    end
+
+    # The name of the dataset from OData
+    #
+    # @return [String] the dataset name
+    #
+    def name
+      odata.root.elements['title'].text
+    end
+
     private
 
-    attr_reader :url
+    attr_reader :original_url
 
     def get(format, params = {})
-      Mocrata::Request.new(base_url, format, params).response
+      Mocrata::Request.new(resource_url, format, params).response
+    end
+
+    def url
+      @url ||= Mocrata::DatasetUrl.new(original_url)
+    end
+
+    def resource_url
+      url.to_resource
     end
 
-    def base_url
-      @base_url ||= Mocrata::DatasetUrl.new(url).normalize
+    def odata_url
+      url.to_odata
     end
 
     def field_names

data/lib/mocrata/dataset_url.rb

@@ -19,19 +19,20 @@ module Mocrata
       @original = original
     end
 
-    # Normalize a Socrata dataset URL. Ensures https protocol. Removes query
-    # string and fragment, if any.
+    # Convert the original URL to a normalized resource URL
     #
-    # @return [String] the normalized URL
+    # @return [String] the resource URL
     #
-    def normalize
-      uri = URI(self.class.ensure_protocol(original))
-
-      uri.scheme   = 'https'
-      uri.fragment = nil
-      uri.query    = nil
+    def to_resource
+      @to_resource ||= normalize
+    end
 
-      self.class.strip_format(uri.to_s)
+    # Convert the original URL to a normalized OData URL
+    #
+    # @return [String] the OData URL
+    #
+    def to_odata
+      @to_odata ||= normalize.gsub(/\/resource\//, '/OData.svc/')
     end
 
     # Validate the original URL against the expected Socrata dataset URL
@@ -79,6 +80,21 @@ module Mocrata
 
     VALID_PATTERN = /\/resource\//
 
+    # Normalize a Socrata dataset URL. Ensures https protocol. Removes query
+    # string and fragment, if any.
+    #
+    # @return [String] the normalized URL
+    #
+    def normalize
+      uri = URI(self.class.ensure_protocol(original))
+
+      uri.scheme   = 'https'
+      uri.fragment = nil
+      uri.query    = nil
+
+      self.class.strip_format(uri.to_s)
+    end
+
     class InvalidError < StandardError; end
   end
 end

data/lib/mocrata/request.rb

@@ -5,26 +5,38 @@ require 'csv'
 require 'json'
 require 'net/https'
 
+require 'mocrata/version'
+
 module Mocrata
   # @attr_reader [String] url the request URL
   # @attr_reader [Symbol] format the request format, `:json` or `:csv`
-  # @attr_reader [Hash] params the requst params
+  # @attr_reader [Hash] options hash of options
+  # @attr_reader [Hash] params the request params
   #
   class Request
-    attr_reader :url, :format, :params
+    attr_reader :url, :format, :options, :params
 
     # Construct a new Request instance
     #
     # @param url [String] the request URL
     # @param format [Symbol] the request format, `:json` or `:csv`
-    # @param params [Hash] the requst params
+    # @param options [optional, Hash] hash of options
+    # @param params [optional, Hash] the request params
+    #
+    # @option options [Integer] :page the page to request
+    # @option options [Integer] :per_page the number of rows to return for each
+    #   page
+    # @option options [true, false] :paginate whether to add pagination params
+    # @option options [true, false] :preserve_header whether to preserve CSV
+    #   header
     #
     # @return [Mocrata::Request] the instance
     #
-    def initialize(url, format, params = {})
-      @url    = url
-      @format = format
-      @params = params
+    def initialize(url, format, options = {}, params = {})
+      @url     = url
+      @format  = format
+      @options = options
+      @params  = params
     end
 
     # Perform the HTTP GET request
@@ -34,12 +46,14 @@ module Mocrata
     def response
       request = Net::HTTP::Get.new(uri.request_uri)
 
-      request.add_field('Accept', content_type)
-      request.add_field('X-App-Token', Mocrata.config.app_token)
+      request['accept']     = content_type
+      request['user-agent'] = USER_AGENT
+
+      request.add_field('x-app-token', Mocrata.config.app_token)
 
       response = http.request(request)
 
-      Mocrata::Response.new(response).tap(&:validate!)
+      Mocrata::Response.new(response, response_options).tap(&:validate!)
     end
 
     # @return [String] the content type for the specified format
@@ -54,6 +68,9 @@ module Mocrata
 
     private
 
+    USER_AGENT = "mocrata/#{Mocrata::VERSION}"
+    SODA_PARAM_KEYS = %w(top limit)
+
     def http
       @http ||= Net::HTTP.new(uri.host, uri.port).tap do |http|
         http.use_ssl     = true
@@ -63,16 +80,40 @@ module Mocrata
 
     def soda_params
       @soda_params ||= {}.tap do |soda|
-        limit = params.fetch(:per_page, Mocrata.config.per_page)
-        page  = params.fetch(:page, 1)
+        soda.merge!(pagination_params) if paginate?
+
+        SODA_PARAM_KEYS.each do |key|
+          if params.has_key?(key.to_sym)
+            soda[:"$#{key}"] = params.fetch(key.to_sym)
+          end
+        end
+      end
+    end
+
+    def pagination_params
+      {}.tap do |result|
+        limit = options.fetch(:per_page, Mocrata.config.per_page)
+        page  = options.fetch(:page, 1)
+
+        result[:$limit]  = limit
+        result[:$offset] = (page - 1) * limit
+      end
+    end
+
+    def paginate?
+      options.fetch(:paginate, false) ||
+        options.has_key?(:page) ||
+        options.has_key?(:per_page)
+    end
 
-        soda[:$limit]  = limit
-        soda[:$offset] = (page - 1) * limit
+    def response_options
+      options.keep_if do |key, value|
+        Mocrata::Response::OPTIONS.include?(key)
       end
     end
 
     def uri
-      @uri ||= URI(url).dup.tap do |uri|
+      @uri ||= URI(url).tap do |uri|
         uri.query = self.class.query_string(soda_params)
       end
     end

data/lib/mocrata/response.rb

@@ -1,18 +1,26 @@
 # encoding: utf-8
 #
-require 'json'
 require 'csv'
+require 'json'
+require 'rexml/document'
 
 module Mocrata
   class Response
+    OPTIONS = [:preserve_header]
+
     # Construct a new Response instance
     #
     # @param http_response [Net::HTTPResponse] the http response
+    # @param options [Hash] hash of options
+    #
+    # @option options [true, false] :preserve_header whether to preserve CSV
+    #   header
     #
     # @return [Mocrata::Response] the instance
     #
-    def initialize(http_response)
+    def initialize(http_response, options = {})
       @http_response = http_response
+      @options       = options
     end
 
     # Perform certain checks against the HTTP response and raise an exception
@@ -29,6 +37,10 @@ module Mocrata
         end
       end
 
+      unless code == 200
+        raise ResponseError.new("Unexpected response code: #{code}")
+      end
+
       true
     end
 
@@ -46,6 +58,10 @@ module Mocrata
       end
     end
 
+    def code
+      http_response.code.to_i
+    end
+
     # The HTTP response body, processed according to content type
     #
     # @return [Array] the parsed body
@@ -59,7 +75,7 @@ module Mocrata
     # SODA headers that are always encoded as JSON
     JSON_HEADERS = %w(x-soda2-fields x-soda2-types)
 
-    attr_reader :http_response
+    attr_reader :http_response, :options
 
     def content_type
       type = headers['content-type']
@@ -72,13 +88,23 @@ module Mocrata
     end
 
     def csv
-      CSV.parse(http_response.body)[1..-1] # exclude header
+      result = CSV.parse(http_response.body)
+      result = result[1..-1] unless preserve_header?
+      result
     end
 
     def json
       JSON.parse(http_response.body)
     end
 
+    def xml
+      REXML::Document.new(http_response.body)
+    end
+
+    def preserve_header?
+      options.fetch(:preserve_header, false)
+    end
+
     class ResponseError < StandardError; end
   end
 end

data/lib/mocrata/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 #
 module Mocrata
-  VERSION = "0.0.1"
+  VERSION = '0.1.0'
 end

data/mocrata.gemspec

@@ -22,7 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "rdoc"
 
   spec.required_ruby_version = "~> 2.0"
 end

data/spec/lib/mocrata/dataset_spec.rb

@@ -31,10 +31,12 @@ describe Mocrata::Dataset do
 
   describe '#each_page' do
     it 'yields pages' do
-      expect(dataset).to receive(:json).and_return(*pages)
+      response = double(:response)
+      expect(response).to receive(:body).and_return(*pages)
+      expect(dataset).to receive(:get).and_return(response).at_least(:once)
 
       expect { |b|
-        dataset.each_page(:json, 4, &b)
+        dataset.each_page(:json, :per_page => 4, &b)
       }.to yield_successive_args(*pages)
     end
   end
@@ -53,6 +55,38 @@ describe Mocrata::Dataset do
     end
   end
 
+  describe '#name' do
+    it 'fetches name from odata' do
+      dataset = Mocrata::Dataset.new(
+        'https://data.sfgov.org/resource/dataset-identifier')
+
+      xml = %{<feed>
+      <title type="text">Test name</title>
+      <id>http://opendata.socrata.com/OData.svc/dataset-identifier</id>
+      <updated>2012-06-15T18:15:19Z</updated>
+      </feed>}
+
+      expect(dataset).to receive(:odata).and_return(REXML::Document.new(xml))
+      expect(dataset.name).to eq('Test name')
+    end
+  end
+
+  describe '#odata' do
+    it 'returns odata xml document' do
+      dataset = Mocrata::Dataset.new(
+        'https://data.sfgov.org/resource/funx-qxxn')
+
+      response = Mocrata::Response.new(true)
+      expect(response).to receive(:content_type).and_return(:xml)
+      expect(response).to receive(:http_response).and_return(
+        double(:http_response, :body => ''))
+      expect_any_instance_of(Mocrata::Request).to receive(
+        :response).and_return(response)
+
+      expect(dataset.odata).to be_an_instance_of(REXML::Document)
+    end
+  end
+
   describe '#csv' do
     it 'returns csv body' do
       response = Mocrata::Response.new(true)
@@ -64,6 +98,20 @@ describe Mocrata::Dataset do
     end
   end
 
+  describe '#csv_header' do
+    it 'returns csv header' do
+      dataset = Mocrata::Dataset.new(
+        'https://data.sfgov.org/resource/funx-qxxn')
+
+      response = double(:response, :body => [['foo', 'bar']])
+
+      expect_any_instance_of(Mocrata::Request).to receive(
+        :response).and_return(response)
+
+      expect(dataset.csv_header).to eq(['foo', 'bar'])
+    end
+  end
+
   describe '#json' do
     it 'returns json body' do
       response = Mocrata::Response.new(true)

data/spec/lib/mocrata/dataset_url_spec.rb

@@ -25,7 +25,8 @@ describe Mocrata::DatasetUrl do
       url = Mocrata::DatasetUrl.new(
         'data.sfgov.org/resource/funx-qxxn.csv?limit=100#foo')
 
-      expect(url.normalize).to eq('https://data.sfgov.org/resource/funx-qxxn')
+      expect(url.send(:normalize)).to eq(
+        'https://data.sfgov.org/resource/funx-qxxn')
     end
   end
 

data/spec/lib/mocrata/request_spec.rb

@@ -54,22 +54,97 @@ describe Mocrata::Request do
   end
 
   describe '#soda_params' do
-    it 'is formed with default params' do
+    describe 'with pagination' do
+      it 'has default params' do
+        request = Mocrata::Request.new('', nil, :paginate => true)
+
+        result = request.send(:soda_params)
+
+        expect(result).to eq(:$limit => 1000, :$offset => 0)
+      end
+
+      it 'has custom params' do
+        request = Mocrata::Request.new('', nil, :paginate => true, :page => 2)
+
+        result = request.send(:soda_params)
+
+        expect(result).to eq(:$limit => 1000, :$offset => 1000)
+      end
+    end
+
+    describe 'without pagination' do
+      it 'is empty by default' do
+        request = Mocrata::Request.new('', nil)
+
+        expect(request.send(:soda_params)).to eq({})
+      end
+    end
+
+    it 'ignores unrecognized parameters' do
+      request = Mocrata::Request.new('', nil, {}, { :foo => 'bar', :top => 0 })
+
+      expect(request.send(:soda_params)).to eq(:$top => 0)
+    end
+  end
+
+  describe '#pagination_params' do
+    it 'is formed with default pagination options' do
+      request = Mocrata::Request.new('', nil, :paginate => true)
+
+      result = request.send(:pagination_params)
+
+      expect(result).to eq(:$limit => 1000, :$offset => 0)
+    end
+
+    it 'is formed with custom pagination options' do
+      request = Mocrata::Request.new('', nil,
+        :page => 5, :per_page => 100)
+
+      result = request.send(:pagination_params)
+
+      expect(result).to eq(:$limit => 100, :$offset => 400)
+    end
+  end
+
+  describe '#paginate?' do
+    it 'is false by default' do
       request = Mocrata::Request.new('', nil)
 
-      expect(request.send(:soda_params)).to eq(:$limit => 1000, :$offset => 0)
+      expect(request.send(:paginate?)).to eq(false)
     end
 
-    it 'is formed with custom params' do
-      request = Mocrata::Request.new('', nil, :page => 5, :per_page => 100)
+    it 'allows override' do
+      request = Mocrata::Request.new('', nil, :paginate => true)
 
-      expect(request.send(:soda_params)).to eq(:$limit => 100, :$offset => 400)
+      expect(request.send(:paginate?)).to eq(true)
     end
 
-    it 'ignores custom params' do
-      request = Mocrata::Request.new('', nil, :wat => 'nope')
+    it 'is true if page option is present' do
+      request = Mocrata::Request.new('', nil, :page => 1)
 
-      expect(request.send(:soda_params)).to eq(:$limit => 1000, :$offset => 0)
+      expect(request.send(:paginate?)).to eq(true)
+    end
+
+    it 'is true if per_page option is present' do
+      request = Mocrata::Request.new('', nil, :per_page => 1)
+
+      expect(request.send(:paginate?)).to eq(true)
+    end
+  end
+
+  describe '#response_options' do
+    it 'is empty by default' do
+      request = Mocrata::Request.new('', nil)
+
+      expect(request.send(:response_options)).to eq({})
+    end
+
+    it 'filters request options' do
+      request = Mocrata::Request.new('', nil,
+        :page => 1,
+        :preserve_header => true)
+
+      expect(request.send(:response_options)).to eq(:preserve_header => true)
     end
   end
 
@@ -80,7 +155,7 @@ describe Mocrata::Request do
 
     it 'is formed with default parameters' do
       request = Mocrata::Request.new(
-        'https://data.sfgov.org/resource/funx-qxxn', nil)
+        'https://data.sfgov.org/resource/funx-qxxn', nil, :paginate => true)
 
       result = request.send(:uri).to_s
 
@@ -92,7 +167,8 @@ describe Mocrata::Request do
       request = Mocrata::Request.new(
         'https://data.sfgov.org/resource/funx-qxxn', nil,
         :per_page => 5,
-        :page     => 3)
+        :page     => 3,
+        :paginate => true)
 
       result = request.send(:uri).to_s
 

data/spec/lib/mocrata/response_spec.rb

@@ -9,27 +9,40 @@ describe Mocrata::Response do
 
   describe '#validate!' do
     it 'returns true without content type' do
+      expect(response).to receive(:code).and_return(200)
       expect(response).to receive(:content_type).and_return(nil)
       expect(response.validate!).to be true
     end
 
     it 'returns true with csv content' do
+      expect(response).to receive(:code).and_return(200)
       expect(response).to receive(:content_type).and_return(:csv)
       expect(response.validate!).to be true
     end
 
     it 'returns true with json array' do
+      expect(response).to receive(:code).and_return(200)
       expect(response).to receive(:content_type).and_return(:json)
       expect(response).to receive(:body).and_return([])
       expect(response.validate!).to be true
     end
 
     it 'returns true with json array' do
+      expect(response).to receive(:code).and_return(200)
       expect(response).to receive(:content_type).and_return(:json)
       expect(response).to receive(:body).at_least(:once).and_return({})
       expect(response.validate!).to be true
     end
 
+    it 'raises exception if response code is unexpected' do
+      expect(response).to receive(:code).and_return(201).at_least(:once)
+      expect(response).to receive(:content_type).and_return(:json)
+      expect(response).to receive(:body).at_least(:once).and_return({})
+
+      expect { response.validate! }.to raise_error(
+        Mocrata::Response::ResponseError)
+    end
+
     it 'raises exception with json error' do
       expect(response).to receive(:content_type).and_return(:json)
       expect(response).to receive(:body).at_least(:once).and_return(
@@ -79,10 +92,21 @@ describe Mocrata::Response do
   end
 
   describe '#csv' do
-    it 'parses body and excludes header' do
-      csv = "\"header1\"\n\"row1\"\n\"row2\""
-      expect(response.send(:http_response)).to receive(:body).and_return(csv)
-      expect(response.send(:csv)).to eq([['row1'], ['row2']])
+    describe 'without header' do
+      it 'parses body and excludes header' do
+        csv = "\"header1\"\n\"row1\"\n\"row2\""
+        expect(response.send(:http_response)).to receive(:body).and_return(csv)
+        expect(response.send(:csv)).to eq([['row1'], ['row2']])
+      end
+    end
+
+    describe 'with header' do
+      it 'parses body and preserves header' do
+        expect(response).to receive(:preserve_header?).and_return(true)
+        csv = "\"header1\"\n\"row1\"\n\"row2\""
+        expect(response.send(:http_response)).to receive(:body).and_return(csv)
+        expect(response.send(:csv)).to eq([['header1'], ['row1'], ['row2']])
+      end
     end
   end
 
@@ -129,4 +153,27 @@ describe Mocrata::Response do
         'x-soda2-fields' => { 'name' => 'value' })
     end
   end
+
+  describe '#code' do
+    it 'converts http response status to integer' do
+      http_response = double(:http_response, :code => '200')
+      response = Mocrata::Response.new(http_response)
+
+      expect(response.code).to eq(200)
+    end
+  end
+
+  describe '#preserve_header?' do
+    it 'is false by default' do
+      response = Mocrata::Response.new(true)
+
+      expect(response.send(:preserve_header?)).to eq(false)
+    end
+
+    it 'allows override' do
+      response = Mocrata::Response.new(true, :preserve_header => true)
+
+      expect(response.send(:preserve_header?)).to eq(true)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mocrata
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Heather Rivers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Mode's SODA client
 email:
 - heather@modeanalytics.com
@@ -88,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - .yardopts
 - Gemfile
 - LICENSE.txt