scraperwiki-api 0.0.6 → 0.0.7

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
 rvm:
+  - 1.8.7
+  - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - ree

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--hide-void-return
+--embed-mixin ClassMethods
+--markup=markdown

data/lib/scraperwiki-api.rb

@@ -8,11 +8,11 @@ module ScraperWiki
     base_uri 'api.scraperwiki.com/api/1.0'
 
     RUN_INTERVALS = {
-      never: -1,
-      monthly: 2678400,
-      weekly: 604800,
-      daily: 86400,
-      hourly: 3600,
+      :never   => -1,
+      :monthly => 2678400,
+      :weekly  => 604800,
+      :daily   => 86400,
+      :hourly  => 3600,
     }
 
     class << self
@@ -87,7 +87,7 @@ module ScraperWiki
       if Array === opts[:attach]
         opts[:attach] = opts[:attach].join ';'
       end
-      request_with_apikey '/datastore/sqlite', {name: shortname, query: query}.merge(opts)
+      request_with_apikey '/datastore/sqlite', {:name => shortname, :query => query}.merge(opts)
     end
 
     # Extracts data about a scraper's code, owner, history, etc.
@@ -199,7 +199,7 @@ module ScraperWiki
       if Array === opts[:quietfields]
         opts[:quietfields] = opts[:quietfields].join '|'
       end
-      request_with_apikey '/scraper/getinfo', {name: shortname}.merge(opts)
+      request_with_apikey '/scraper/getinfo', {:name => shortname}.merge(opts)
     end
 
     # See what the scraper did during each run.
@@ -235,7 +235,7 @@ module ScraperWiki
     # @note The query string parameter is +name+, not +shortname+
     #   {https://scraperwiki.com/docs/api#getinfo as in the ScraperWiki docs}
     def scraper_getruninfo(shortname, opts = {})
-      request_with_apikey '/scraper/getruninfo', {name: shortname}.merge(opts)
+      request_with_apikey '/scraper/getruninfo', {:name => shortname}.merge(opts)
     end
 
     # Find out information about a user.
@@ -271,7 +271,7 @@ module ScraperWiki
     # @note The date joined field is +date_joined+ (with underscore) on
     #   {#scraper_usersearch}
     def scraper_getuserinfo(username)
-      request_with_apikey '/scraper/getuserinfo', username: username
+      request_with_apikey '/scraper/getuserinfo', :username => username
     end
 
     # Search the titles and descriptions of all the scrapers.
@@ -341,7 +341,7 @@ module ScraperWiki
     end
 
     def request(path, opts)
-      self.class.get(path, query: opts).parsed_response
+      self.class.get(path, :query => opts).parsed_response
     end
   end
 end

data/lib/scraperwiki-api/matchers.rb

@@ -19,6 +19,7 @@ module ScraperWiki
     #     it {should be_editable_by('frabcus')}
     #     it {should run(:daily)}
     #     it {should_not be_broken}
+    #     it {should have_a_table('swdata')}
     #     it {should have_a_row_count_of(42).on('swdata')}
     #
     #     # Check for missing keys:
@@ -233,6 +234,26 @@ module ScraperWiki
         LastRunMatcher.new expected
       end
 
+      class TableMatcher < ScraperInfoMatcher
+        def matches?(actual)
+          super
+          actual['datasummary']['tables'].key?(@expected)
+        end
+
+        def failure_message
+          "expected #{@actual['short_name']} to have a #{@expected} table"
+        end
+
+        def negative_failure_message
+          "expected #{@actual['short_name']} to not have a #{@expected} table"
+        end
+      end
+      # @example
+      #   it {should have_a_table('swdata')}
+      def have_a_table(expected)
+        TableMatcher.new expected
+      end
+
       class TablesMatcher < ScraperInfoMatcher
         def on(table)
           @table = table
@@ -269,7 +290,12 @@ module ScraperWiki
 
       class MissingKeysMatcher < KeysMatcher
         def difference
-          @expected - @actual['datasummary']['tables'][@table]['keys']
+          keys = if @actual['datasummary']['tables'][@table]
+            @actual['datasummary']['tables'][@table]['keys']
+          else
+            []
+          end
+          @expected - keys
         end
 
         def failure_predicate
@@ -288,7 +314,12 @@ module ScraperWiki
 
       class ExtraKeysMatcher < KeysMatcher
         def difference
-          @actual['datasummary']['tables'][@table]['keys'] - @expected
+          keys = if @actual['datasummary']['tables'][@table]
+            @actual['datasummary']['tables'][@table]['keys']
+          else
+            []
+          end
+          keys - @expected
         end
 
         def failure_predicate
@@ -306,13 +337,21 @@ module ScraperWiki
       end
 
       class CountMatcher < TablesMatcher
+        def count
+          if @actual['datasummary']['tables'][@table]
+            @actual['datasummary']['tables'][@table]['count']
+          else
+            0
+          end
+        end
+
         def matches?(actual)
           super
-          actual['datasummary']['tables'][@table]['count'] == @expected
+          count == @expected
         end
 
         def failure_message
-          "expected #{@actual['short_name']} to have #{@expected} rows, not #{@actual['datasummary']['tables'][@table]['count']}"
+          "expected #{@actual['short_name']} to have #{@expected} rows, not #{count}"
         end
 
         def negative_failure_message
@@ -362,12 +401,16 @@ module ScraperWiki
           @items ||= if Array === @actual
             @actual
           elsif Hash === @actual
-            @actual['data'].map do |array|
-              hash = {}
-              @actual['keys'].each_with_index do |key,index|
-                hash[key] = array[index]
+            if @actual['data']
+              @actual['data'].map do |array|
+                hash = {}
+                @actual['keys'].each_with_index do |key,index|
+                  hash[key] = array[index]
+                end
+                hash
               end
-              hash
+            else
+              {}
             end
           else
             raise NotImplementerError, "Can only handle jsondict or jsonlist formats"

data/lib/scraperwiki-api/version.rb

@@ -1,5 +1,5 @@
 module ScraperWiki
   class API
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

data/scraperwiki-api.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "scraperwiki-api/version"
+require File.expand_path('../lib/scraperwiki-api/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "scraperwiki-api"
@@ -18,7 +17,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency('yajl-ruby', '~> 1.0')
-  s.add_runtime_dependency('httparty', '~> 0.8.0')
+  s.add_runtime_dependency('httparty', '~> 0.10.0')
   s.add_development_dependency('rspec', '~> 2.10')
   s.add_development_dependency('rake')
 end

data/spec/scraperwiki-api_spec.rb

@@ -2,137 +2,135 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 require 'time'
 
-class ScraperWiki::API
-  # We don't want to test the ScraperWiki API. We just want to check that the
-  # wrapper works.
-  describe ScraperWiki::API do
-    EXAMPLE_SHORTNAME = 'frabcus.emailer'
-    EXAMPLE_USERNAME = 'frabcus'
-    QUIETFIELDS = %w(code runevents datasummary userroles history)
+# We don't want to test the ScraperWiki API. We just want to check that the
+# wrapper works.
+describe ScraperWiki::API do
+  EXAMPLE_SHORTNAME = 'frabcus.emailer'
+  EXAMPLE_USERNAME = 'frabcus'
+  QUIETFIELDS = %w(code runevents datasummary userroles history)
+
+  before :all do
+    @api = ScraperWiki::API.new
+  end
 
-    before :all do
-      @api = ScraperWiki::API.new
-    end
+  describe '#datastore_sqlite' do
+    # @todo
+  end
 
-    describe '#datastore_sqlite' do
-      # @todo
+  describe '#scraper_getinfo' do
+    it 'should return a non-empty array containing a single hash' do
+      response = @api.scraper_getinfo EXAMPLE_SHORTNAME
+      response.should be_an(Array)
+      response.should have(1).item
+      response.first.should be_a(Hash)
     end
 
-    describe '#scraper_getinfo' do
-      it 'should return a non-empty array containing a single hash' do
-        response = @api.scraper_getinfo EXAMPLE_SHORTNAME
-        response.should be_an(Array)
-        response.should have(1).item
-        response.first.should be_a(Hash)
-      end
-
-      it 'should respect the :version argument' do
-        bare = @api.scraper_getinfo(EXAMPLE_SHORTNAME).first
-        bare.should_not have_key('currcommit')
-        result = @api.scraper_getinfo(EXAMPLE_SHORTNAME, version: 1).first
-        result.should have_key('currcommit')
-        result['code'].should_not == bare['code']
-      end
+    it 'should respect the :version argument' do
+      bare = @api.scraper_getinfo(EXAMPLE_SHORTNAME).first
+      bare.should_not have_key('currcommit')
+      result = @api.scraper_getinfo(EXAMPLE_SHORTNAME, :version => 1).first
+      result.should have_key('currcommit')
+      result['code'].should_not == bare['code']
+    end
 
-      it 'should respect the :history_start_date argument' do
-        bare = @api.scraper_getinfo(EXAMPLE_SHORTNAME).first
-        bare['history'].should have_at_least(2).items
-        history_start_date = bare['history'][0]['date'][0..9]
-        result = @api.scraper_getinfo(EXAMPLE_SHORTNAME, history_start_date: history_start_date).first
-        result['history'].should have(1).item
-      end
+    it 'should respect the :history_start_date argument' do
+      bare = @api.scraper_getinfo(EXAMPLE_SHORTNAME).first
+      bare['history'].should have_at_least(2).items
+      history_start_date = bare['history'][0]['date'][0..9]
+      result = @api.scraper_getinfo(EXAMPLE_SHORTNAME, :history_start_date => history_start_date).first
+      result['history'].should have(1).item
+    end
 
-      it 'should respect the :quietfields argument (as an array)' do
-        result = @api.scraper_getinfo(EXAMPLE_SHORTNAME, quietfields: QUIETFIELDS).first
-        QUIETFIELDS.each do |key|
-          result.should_not have_key(key)
-        end
+    it 'should respect the :quietfields argument (as an array)' do
+      result = @api.scraper_getinfo(EXAMPLE_SHORTNAME, :quietfields => QUIETFIELDS).first
+      QUIETFIELDS.each do |key|
+        result.should_not have_key(key)
       end
+    end
 
-      it 'should respect the :quietfields argument (as an string)' do
-        result = @api.scraper_getinfo(EXAMPLE_SHORTNAME, quietfields: QUIETFIELDS.join('|')).first
-        QUIETFIELDS.each do |key|
-          result.should_not have_key(key)
-        end
+    it 'should respect the :quietfields argument (as an string)' do
+      result = @api.scraper_getinfo(EXAMPLE_SHORTNAME, :quietfields => QUIETFIELDS.join('|')).first
+      QUIETFIELDS.each do |key|
+        result.should_not have_key(key)
       end
     end
+  end
 
-    describe '#scraper_getruninfo' do
-      it 'should return a non-empty array containing a single hash' do
-        response = @api.scraper_getruninfo EXAMPLE_SHORTNAME
-        response.should be_an(Array)
-        response.should have(1).item
-        response.first.should be_a(Hash)
-      end
+  describe '#scraper_getruninfo' do
+    it 'should return a non-empty array containing a single hash' do
+      response = @api.scraper_getruninfo EXAMPLE_SHORTNAME
+      response.should be_an(Array)
+      response.should have(1).item
+      response.first.should be_a(Hash)
+    end
 
-      it 'should respect the :runid argument' do
-        runevents = @api.scraper_getinfo(EXAMPLE_SHORTNAME).first['runevents']
-        bare = @api.scraper_getruninfo(EXAMPLE_SHORTNAME).first
-        bare['runid'].should == runevents.first['runid']
-        response = @api.scraper_getruninfo(EXAMPLE_SHORTNAME, runid: runevents.last['runid']).first
-        response['runid'].should_not == bare['runid']
-      end
+    it 'should respect the :runid argument' do
+      runevents = @api.scraper_getinfo(EXAMPLE_SHORTNAME).first['runevents']
+      bare = @api.scraper_getruninfo(EXAMPLE_SHORTNAME).first
+      bare['runid'].should == runevents.first['runid']
+      response = @api.scraper_getruninfo(EXAMPLE_SHORTNAME, :runid => runevents.last['runid']).first
+      response['runid'].should_not == bare['runid']
     end
+  end
 
-    describe '#scraper_getuserinfo' do
-      it 'should return a non-empty array containing a single hash' do
-        response = @api.scraper_getuserinfo EXAMPLE_USERNAME
-        response.should be_an(Array)
-        response.should have(1).item
-        response.first.should be_a(Hash)
-      end
+  describe '#scraper_getuserinfo' do
+    it 'should return a non-empty array containing a single hash' do
+      response = @api.scraper_getuserinfo EXAMPLE_USERNAME
+      response.should be_an(Array)
+      response.should have(1).item
+      response.first.should be_a(Hash)
     end
+  end
 
-    describe '#scraper_search' do
-      it 'should return a non-empty array of hashes' do
-        response = @api.scraper_search
-        response.should be_an(Array)
-        response.should have_at_least(1).item
-        response.first.should be_a(Hash)
-      end
+  describe '#scraper_search' do
+    it 'should return a non-empty array of hashes' do
+      response = @api.scraper_search
+      response.should be_an(Array)
+      response.should have_at_least(1).item
+      response.first.should be_a(Hash)
+    end
 
-      it 'should respect the :searchquery argument' do
-        @api.scraper_search(searchquery: EXAMPLE_SHORTNAME).find{|result|
-          result['short_name'] == EXAMPLE_SHORTNAME
-        }.should_not be_nil
-      end
+    it 'should respect the :searchquery argument' do
+      @api.scraper_search(:searchquery => EXAMPLE_SHORTNAME).find{|result|
+        result['short_name'] == EXAMPLE_SHORTNAME
+      }.should_not be_nil
+    end
 
-      it 'should respect the :maxrows argument' do
-        @api.scraper_search(maxrows: 1).should have(1).item
-      end
+    it 'should respect the :maxrows argument' do
+      @api.scraper_search(:maxrows => 1).should have(1).item
     end
+  end
 
-    describe '#scraper_usersearch' do
-      it 'should return a non-empty array of hashes' do
-        response = @api.scraper_usersearch
-        response.should be_an(Array)
-        response.should have_at_least(1).item
-        response.first.should be_a(Hash)
-      end
+  describe '#scraper_usersearch' do
+    it 'should return a non-empty array of hashes' do
+      response = @api.scraper_usersearch
+      response.should be_an(Array)
+      response.should have_at_least(1).item
+      response.first.should be_a(Hash)
+    end
 
-      it 'should respect the :searchquery argument' do
-        @api.scraper_usersearch(searchquery: EXAMPLE_USERNAME).find{|result|
-          result['username'] == EXAMPLE_USERNAME
-        }.should_not be_nil
-      end
+    it 'should respect the :searchquery argument' do
+      @api.scraper_usersearch(:searchquery => EXAMPLE_USERNAME).find{|result|
+        result['username'] == EXAMPLE_USERNAME
+      }.should_not be_nil
+    end
 
-      it 'should respect the :maxrows argument' do
-        @api.scraper_usersearch(maxrows: 1).should have(1).item
-      end
+    it 'should respect the :maxrows argument' do
+      @api.scraper_usersearch(:maxrows => 1).should have(1).item
+    end
 
-      it 'should respect the :nolist argument (as an array)' do
-        usernames = @api.scraper_usersearch.map{|result| result['username']}
-        @api.scraper_usersearch(nolist: usernames).find{|result|
-          usernames.include? result['username']
-        }.should be_nil
-      end
+    it 'should respect the :nolist argument (as an array)' do
+      usernames = @api.scraper_usersearch.map{|result| result['username']}
+      @api.scraper_usersearch(:nolist => usernames).find{|result|
+        usernames.include? result['username']
+      }.should be_nil
+    end
 
-      it 'should respect the :nolist argument (as an string)' do
-        usernames = @api.scraper_usersearch.map{|result| result['username']}
-        @api.scraper_usersearch(nolist: usernames.join(' ')).find{|result|
-          usernames.include? result['username']
-        }.should be_nil
-      end
+    it 'should respect the :nolist argument (as an string)' do
+      usernames = @api.scraper_usersearch.map{|result| result['username']}
+      @api.scraper_usersearch(:nolist => usernames.join(' ')).find{|result|
+        usernames.include? result['username']
+      }.should be_nil
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scraperwiki-api
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-21 00:00:00.000000000 Z
+date: 2013-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE
 - README.md
@@ -115,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: The ScraperWiki API Ruby Gem