enigma_io 0.0.1 → 0.0.2

data/README.md

@@ -10,7 +10,7 @@ Note that you need api key to use their api.
 
 Add this line to your application's Gemfile:
 
-    gem 'enigma'
+    gem 'enigma_io'
 
 And then execute:
 
@@ -18,7 +18,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install enigma
+    $ gem install enigma_io
 
 ## Usage
 

data/lib/enigma/download.rb

@@ -15,6 +15,9 @@ module Enigma
       self.response = res
     end
 
+    # This url is where the file will eventually be available. Returns
+    # a 404 until then
+    #
     def download_url
       response.export_url
     end
@@ -23,8 +26,15 @@ module Enigma
       response.datapath
     end
 
+    # Actually goes and fetches the download. Don't return the
+    # raw_download because it's a massive amount of data that will
+    # take over your terminal in IRB mode.
+    #
+    # @return true on success
+    #
     def get
       @raw_download ||= do_download
+      true
     end
 
     def write(io)

data/lib/enigma/endpoints/export.rb

@@ -2,7 +2,7 @@
 module Enigma
   # The export endpoint has no filtering, but it returns a URL where
   # the download will eventually be available. This client will
-  # default to waiting for the file to be available before continuing
+  # return a `Download` object which can be asked to go get the file
   #
   class Export < Endpoint
     attr_accessor :download, :unzip

data/lib/enigma/version.rb

@@ -2,5 +2,5 @@
 
 # Enigma version
 module Enigma
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enigma_io
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-27 00:00:00.000000000 Z
+date: 2014-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -191,33 +191,36 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2110614023640464768
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby client for the Enigma API
 test_files:
-- test/export_test.rb
-- test/endpoint_test.rb
-- test/stats_test.rb
-- test/response_test.rb
-- test/test_helper.rb
-- test/meta_test.rb
-- test/data_test.rb
 - test/client_test.rb
-- test/fixtures/download.zip
+- test/data_test.rb
+- test/endpoint_test.rb
+- test/export_test.rb
 - test/fixtures/download.csv
-- test/fixtures/vcr_cassettes/selected_data.yml
-- test/fixtures/vcr_cassettes/page_data.yml
-- test/fixtures/vcr_cassettes/simple_stats.yml
-- test/fixtures/vcr_cassettes/sorted_data.yml
-- test/fixtures/vcr_cassettes/filtered_data.yml
-- test/fixtures/vcr_cassettes/sorted_data_descending.yml
+- test/fixtures/download.zip
 - test/fixtures/vcr_cassettes/compound_average.yml
 - test/fixtures/vcr_cassettes/data_with_error.yml
-- test/fixtures/vcr_cassettes/simple_data.yml
-- test/fixtures/vcr_cassettes/limit_data.yml
 - test/fixtures/vcr_cassettes/export.yml
+- test/fixtures/vcr_cassettes/filtered_data.yml
+- test/fixtures/vcr_cassettes/limit_data.yml
+- test/fixtures/vcr_cassettes/page_data.yml
+- test/fixtures/vcr_cassettes/selected_data.yml
+- test/fixtures/vcr_cassettes/simple_data.yml
 - test/fixtures/vcr_cassettes/simple_metadata.yml
+- test/fixtures/vcr_cassettes/simple_stats.yml
+- test/fixtures/vcr_cassettes/sorted_data.yml
+- test/fixtures/vcr_cassettes/sorted_data_descending.yml
+- test/meta_test.rb
+- test/response_test.rb
+- test/stats_test.rb
+- test/test_helper.rb
 has_rdoc: