enigma_io 0.0.1

data/test/client_test.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+class EnigmaTest < Test::Unit::TestCase
+  def setup
+    ENV['ENIGMA_KEY'] = nil
+  end
+
+  def test_initialize_handle
+    Enigma::Client.new(key: 'test')
+    assert_equal 'test', Enigma.key
+  end
+
+  def test_initialize_key_from_env
+    ENV['ENIGMA_KEY'] = 'test'
+    Enigma::Client.new
+    assert_equal 'test', Enigma.key
+  end
+
+  def test_prefers_key_from_env
+    ENV['ENIGMA_KEY'] = 'env_key'
+    Enigma::Client.new(key: 'bogus')
+    assert_equal 'env_key', Enigma.key
+  end
+
+  def test_requires_key
+    assert_raises ArgumentError do
+      Enigma::Client.new
+    end
+  end
+end

data/test/data_test.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+class DataTest < Test::Unit::TestCase
+  def setup
+    @client = Enigma::Client.new(key: TEST_KEY)
+  end
+
+  def test_bad_request
+    VCR.use_cassette('data_with_error') do
+      assert_raises RuntimeError do
+        response = @client.data('us.gov.whitehouse.salaries')
+      end
+    end
+  end
+
+  def test_simple_data_request
+    VCR.use_cassette('simple_data') do
+      response = @client.data('us.gov.whitehouse.visitor-list')
+      assert_equal 500, response.info.rows_limit
+      assert_equal 3427529, response.info.total_results
+      assert_equal 'TED', response.result.first.namefirst
+    end
+  end
+
+  def test_filter_with_search
+    VCR.use_cassette('filtered_data') do
+      response = @client.data('us.gov.whitehouse.visitor-list',
+                              search: { namefirst: ['Steve', 'Joe'] })
+      assert_equal ['JOE', 'STEVE'], response.result.map(&:namefirst).uniq.sort
+    end
+  end
+
+  def test_filter_with_select
+    VCR.use_cassette('selected_data') do
+      response = @client.data('us.gov.whitehouse.visitor-list',
+                              select: ['namefirst', 'namelast'])
+      assert_equal nil, response.result.first.appt_made_date
+      assert response.result.first.namefirst
+    end
+  end
+
+  def test_sort
+    VCR.use_cassette('sorted_data_descending') do
+      response = @client.data('us.gov.whitehouse.visitor-list',
+                              sort: 'namefirst-')
+      names = response.result.map(&:firstname)
+      assert_equal names, names.sort.reverse
+    end
+  end
+
+  def test_limit
+    VCR.use_cassette('limit_data') do
+      response = @client.data('us.gov.whitehouse.visitor-list',
+                              limit: 1)
+      assert response.info.total_results > 1
+      assert_equal 1, response.info.rows_limit
+      assert_equal 1, response.result.count
+    end
+  end
+
+  def test_page
+    VCR.use_cassette('page_data') do
+      response = @client.data('us.gov.whitehouse.visitor-list',
+                              limit: 1, page: 2)
+      assert response.info.total_results > 1
+      assert_equal 1, response.info.rows_limit
+      assert_equal 2, response.info.current_page
+    end
+  end
+
+  def test_sort_defaults_ascending
+    VCR.use_cassette('sorted_data') do
+      response = @client.data('us.gov.whitehouse.visitor-list',
+                              sort: 'namefirst')
+      names = response.result.map(&:firstname)
+      assert_equal names, names.sort
+    end
+  end
+end

data/test/endpoint_test.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+class EndpointTest < Test::Unit::TestCase
+  def setup
+    ENV['ENIGMA_KEY'] = 'test_key'
+    @datapath = 'us.gov.whitehouse.visitor-list'
+    @ep = Enigma::Endpoint.new(@datapath)
+  end
+
+  def test_needs_datapath
+    assert_raises ArgumentError do
+      Enigma::Endpoint.new
+    end
+  end
+
+  def test_query_params
+    ep = Enigma::Endpoint.new(@datapath, limit: 100)
+    assert_equal({ limit: 100 }, ep.params)
+  end
+
+  def test_has_descendants
+    assert Enigma::Endpoint.descendants.include? Enigma::Meta
+  end
+
+  def test_where_clause_from_hash
+    assert_equal 'firstName=Steve', @ep.serialize_where({ firstName: 'Steve' })
+  end
+
+  def test_where_clause_from_string
+    assert_equal 'firstName=Steve', @ep.serialize_where('firstName=Steve')
+  end
+
+  def test_search_clause_from_hash
+    search_hash = { nameFirst: 'andrew', nameLast: ['white', 'brown', 'black'] }
+    assert_equal('@nameFirst (andrew) @nameLast (white|brown|black)',
+                 @ep.serialize_search(search_hash))
+  end
+
+  def test_search_clause_from_string
+    search = '@namefirst (andrew) @namelast (white|brown)'
+    assert_equal(search, @ep.serialize_search(search))
+  end
+
+  def test_select_clause_from_string
+    select = 'namefirst,namelast'
+    assert_equal(select, @ep.serialize_select(select))
+  end
+
+  def test_select_clause_from_array
+    select = ['namefirst', 'namelast']
+    assert_equal('namefirst,namelast', @ep.serialize_select(select))
+  end
+end

data/test/export_test.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+require 'test_helper'
+
+class ExportTest < Test::Unit::TestCase
+  def setup
+    @client = Enigma::Client.new(key: TEST_KEY)
+    Enigma::Download.any_instance.stubs(:sleep)
+
+    # These are identical, just one is zipped
+    @zipped = File.read 'test/fixtures/download.zip'
+    @unzipped = File.read 'test/fixtures/download.csv'
+
+    # www.example.com is the URL in the response to the export
+    # cassette
+    stub_request(:get, 'www.example.com').to_return do
+      if @tried
+        { body: @zipped }
+      else
+        @tried = true
+        { status: 404 }
+      end
+    end
+  end
+
+  def test_export_no_dl
+    VCR.use_cassette('export') do
+      dl = @client.export('us.gov.whitehouse.visitor-list')
+      assert dl.response.export_url
+    end
+  end
+
+  def test_export_with_dl
+    VCR.use_cassette('export') do
+      dl = @client.export('us.gov.whitehouse.visitor-list')
+      dl.get
+      assert_equal @zipped, dl.raw_download
+    end
+  end
+
+  def test_writing_zip
+    VCR.use_cassette('export') do
+      dl = @client.export('us.gov.whitehouse.visitor-list')
+      dl.get
+      testIO = StringIO.new
+      dl.write(testIO)
+      assert_equal @zipped, testIO.string
+    end
+  end
+
+  def test_writing_csv
+    VCR.use_cassette('export') do
+      dl = @client.export('us.gov.whitehouse.visitor-list')
+      dl.get
+      testIO = StringIO.new
+      dl.write_csv(testIO)
+      assert_equal @unzipped, testIO.string
+    end
+  end
+
+  def test_parse_as_csv
+    VCR.use_cassette('export') do
+      dl = @client.export('us.gov.whitehouse.visitor-list')
+      parsed = dl.parse
+      assert_equal 'Steve', parsed.first[:name]
+    end
+  end
+end

data/test/fixtures/download.csv

@@ -0,0 +1,4 @@
+id,name
+1,Steve
+2,Joe
+3,Alice

data/test/fixtures/vcr_cassettes/compound_average.yml

@@ -0,0 +1,121 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.enigma.io/v2/stats/test-key/us.gov.whitehouse.visitor-list?by=avg&of=total_people&select=release_date
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.9
+      Date:
+      - Sun, 26 Jan 2014 21:27:58 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '5971'
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Etag:
+      - ! '"1451852404"'
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"datapath\": \"us.gov.whitehouse.visitor-list\",\n  \"success\":
+        true,\n  \"info\": {\n    \"column\": {\n      \"id\": \"release_date\",\n
+        \     \"label\": \"Release Date\",\n      \"description\": \"Release Date\",\n
+        \     \"type\": \"type_date\",\n      \"index\": 28\n    },\n    \"operations\":
+        [\n      \"compound_avg\"\n    ],\n    \"rows_limit\": 500,\n    \"total_results\":
+        52,\n    \"total_pages\": 1,\n    \"current_page\": 1\n  },\n  \"result\":
+        {\n    \"compound_avg\": [\n      {\n        \"release_date\": \"2010-03-26T00:00:00.000Z\",\n
+        \       \"avg\": \"734.1429047671963552\"\n      },\n      {\n        \"release_date\":
+        \"2013-11-08T00:00:00.000Z\",\n        \"avg\": \"679.4682244439277687\"\n
+        \     },\n      {\n        \"release_date\": \"2012-06-29T00:00:00.000Z\",\n
+        \       \"avg\": \"533.7427734055372897\"\n      },\n      {\n        \"release_date\":
+        \"2010-08-27T00:00:00.000Z\",\n        \"avg\": \"455.2680450957263406\"\n
+        \     },\n      {\n        \"release_date\": \"2010-09-24T00:00:00.000Z\",\n
+        \       \"avg\": \"439.1832508722477381\"\n      },\n      {\n        \"release_date\":
+        \"2011-12-30T00:00:00.000Z\",\n        \"avg\": \"437.2926486009161654\"\n
+        \     },\n      {\n        \"release_date\": \"2011-09-30T00:00:00.000Z\",\n
+        \       \"avg\": \"421.4652122579903666\"\n      },\n      {\n        \"release_date\":
+        \"2013-04-26T00:00:00.000Z\",\n        \"avg\": \"416.6219928445120697\"\n
+        \     },\n      {\n        \"release_date\": \"2012-01-27T00:00:00.000Z\",\n
+        \       \"avg\": \"415.6607848640052387\"\n      },\n      {\n        \"release_date\":
+        \"2010-10-29T00:00:00.000Z\",\n        \"avg\": \"377.5752650405801174\"\n
+        \     },\n      {\n        \"release_date\": \"2012-09-28T00:00:00.000Z\",\n
+        \       \"avg\": \"354.3737179806018403\"\n      },\n      {\n        \"release_date\":
+        \"2012-10-26T00:00:00.000Z\",\n        \"avg\": \"340.0990311924978385\"\n
+        \     },\n      {\n        \"release_date\": \"2011-10-28T00:00:00.000Z\",\n
+        \       \"avg\": \"323.4379794352864371\"\n      },\n      {\n        \"release_date\":
+        \"2011-01-28T00:00:00.000Z\",\n        \"avg\": \"302.7656493230812774\"\n
+        \     },\n      {\n        \"release_date\": \"2010-06-25T00:00:00.000Z\",\n
+        \       \"avg\": \"290.8586820889530279\"\n      },\n      {\n        \"release_date\":
+        \"2011-03-25T00:00:00.000Z\",\n        \"avg\": \"282.7361624065521076\"\n
+        \     },\n      {\n        \"release_date\": \"2010-01-29T00:00:00.000Z\",\n
+        \       \"avg\": \"281.5727106178477551\"\n      },\n      {\n        \"release_date\":
+        \"2012-07-27T00:00:00.000Z\",\n        \"avg\": \"274.4184635378532728\"\n
+        \     },\n      {\n        \"release_date\": \"2009-12-30T00:00:00.000Z\",\n
+        \       \"avg\": \"264.1159100265728508\"\n      },\n      {\n        \"release_date\":
+        \"2013-03-29T00:00:00.000Z\",\n        \"avg\": \"262.5289941919424726\"\n
+        \     },\n      {\n        \"release_date\": \"2011-11-22T00:00:00.000Z\",\n
+        \       \"avg\": \"255.5073803730738037\"\n      },\n      {\n        \"release_date\":
+        \"2012-03-30T00:00:00.000Z\",\n        \"avg\": \"253.8343781729434669\"\n
+        \     },\n      {\n        \"release_date\": \"2010-11-26T00:00:00.000Z\",\n
+        \       \"avg\": \"249.2652607538964273\"\n      },\n      {\n        \"release_date\":
+        \"2010-02-26T00:00:00.000Z\",\n        \"avg\": \"246.0113161495506823\"\n
+        \     },\n      {\n        \"release_date\": \"2011-07-29T00:00:00.000Z\",\n
+        \       \"avg\": \"245.3487768177846811\"\n      },\n      {\n        \"release_date\":
+        \"2010-07-30T00:00:00.000Z\",\n        \"avg\": \"244.8549041386970590\"\n
+        \     },\n      {\n        \"release_date\": \"2011-06-24T00:00:00.000Z\",\n
+        \       \"avg\": \"237.4581660583941606\"\n      },\n      {\n        \"release_date\":
+        \"2011-08-26T00:00:00.000Z\",\n        \"avg\": \"236.1496245334772247\"\n
+        \     },\n      {\n        \"release_date\": \"2012-02-24T00:00:00.000Z\",\n
+        \       \"avg\": \"212.1851240749513992\"\n      },\n      {\n        \"release_date\":
+        \"2012-11-30T00:00:00.000Z\",\n        \"avg\": \"204.5262752554120889\"\n
+        \     },\n      {\n        \"release_date\": \"2013-01-25T00:00:00.000Z\",\n
+        \       \"avg\": \"204.5012172896871218\"\n      },\n      {\n        \"release_date\":
+        \"2011-02-25T00:00:00.000Z\",\n        \"avg\": \"202.2168111492909595\"\n
+        \     },\n      {\n        \"release_date\": \"2011-05-27T00:00:00.000Z\",\n
+        \       \"avg\": \"190.9268717016875761\"\n      },\n      {\n        \"release_date\":
+        \"2013-02-23T00:00:00.000Z\",\n        \"avg\": \"189.6301864506875896\"\n
+        \     },\n      {\n        \"release_date\": \"2012-08-31T00:00:00.000Z\",\n
+        \       \"avg\": \"185.2720662956690056\"\n      },\n      {\n        \"release_date\":
+        \"2012-12-28T00:00:00.000Z\",\n        \"avg\": \"179.1459236875479497\"\n
+        \     },\n      {\n        \"release_date\": \"2010-05-28T00:00:00.000Z\",\n
+        \       \"avg\": \"178.5372322579505924\"\n      },\n      {\n        \"release_date\":
+        \"2013-06-28T00:00:00.000Z\",\n        \"avg\": \"171.7002070313997623\"\n
+        \     },\n      {\n        \"release_date\": \"2011-04-29T00:00:00.000Z\",\n
+        \       \"avg\": \"163.3204458648374776\"\n      },\n      {\n        \"release_date\":
+        \"2012-05-25T00:00:00.000Z\",\n        \"avg\": \"162.8172296262254902\"\n
+        \     },\n      {\n        \"release_date\": \"2013-05-31T00:00:00.000Z\",\n
+        \       \"avg\": \"154.0788188835038593\"\n      },\n      {\n        \"release_date\":
+        \"2012-04-27T00:00:00.000Z\",\n        \"avg\": \"151.8549782515176139\"\n
+        \     },\n      {\n        \"release_date\": \"2010-04-30T00:00:00.000Z\",\n
+        \       \"avg\": \"150.9765423099860844\"\n      },\n      {\n        \"release_date\":
+        \"2009-10-30T00:00:00.000Z\",\n        \"avg\": \"147.7505197505197505\"\n
+        \     },\n      {\n        \"release_date\": \"2010-12-31T00:00:00.000Z\",\n
+        \       \"avg\": \"142.6299773675648914\"\n      },\n      {\n        \"release_date\":
+        \"2013-09-27T00:00:00.000Z\",\n        \"avg\": \"85.2565229332600934\"\n
+        \     },\n      {\n        \"release_date\": \"2013-07-26T00:00:00.000Z\",\n
+        \       \"avg\": \"84.6897653782523688\"\n      },\n      {\n        \"release_date\":
+        \"2013-11-29T00:00:00.000Z\",\n        \"avg\": \"69.5096365282628379\"\n
+        \     },\n      {\n        \"release_date\": \"2009-11-25T00:00:00.000Z\",\n
+        \       \"avg\": \"64.7715544367526746\"\n      },\n      {\n        \"release_date\":
+        \"2013-08-30T00:00:00.000Z\",\n        \"avg\": \"51.6237960052722295\"\n
+        \     },\n      {\n        \"release_date\": \"2013-12-27T00:00:00.000Z\",\n
+        \       \"avg\": \"48.5304894428625154\"\n      },\n      {\n        \"release_date\":
+        null,\n        \"avg\": \"23.0000000000000000\"\n      }\n    ]\n  }\n}"
+    http_version:
+  recorded_at: Sun, 26 Jan 2014 21:29:03 GMT
+recorded_with: VCR 2.8.0

data/test/fixtures/vcr_cassettes/data_with_error.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.enigma.io/v2/data/test-key/us.gov.whitehouse.salaries
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Server:
+      - nginx/1.2.9
+      Date:
+      - Sun, 26 Jan 2014 21:02:39 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '151'
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - ! '*'
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"success\": false,\n  \"info\": {\n    \"status\": 400,\n    \"message\":
+        \"Bad request\",\n    \"additional\": \"Datapath is not a table\",\n    \"error\":
+        true\n  }\n}"
+    http_version:
+  recorded_at: Sun, 26 Jan 2014 21:03:44 GMT
+recorded_with: VCR 2.8.0

data/test/fixtures/vcr_cassettes/export.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.enigma.io/v2/export/test-key/us.gov.whitehouse.visitor-list
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.9
+      Date:
+      - Sun, 26 Jan 2014 22:10:52 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '302'
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - ! '*'
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"datapath\": \"us.gov.whitehouse.visitor-list\",\n  \"success\":
+        true,\n  \"export_url\": \"www.example.com\"\n}"
+    http_version:
+  recorded_at: Sun, 26 Jan 2014 22:11:57 GMT
+recorded_with: VCR 2.8.0