scraperwiki-api 0.0.5 → 0.0.6

data/.travis.yml

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

data/README.md

@@ -1,6 +1,10 @@
 # The ScraperWiki API Ruby Gem
 
-A Ruby wrapper for the ScraperWiki API.
+A Ruby wrapper for the [ScraperWiki](https://scraperwiki.com/) [API](https://scraperwiki.com/docs/api).
+
+[![Build Status](https://secure.travis-ci.org/opennorth/scraperwiki-api-ruby.png)](http://travis-ci.org/opennorth/scraperwiki-api-ruby)
+[![Dependency Status](https://gemnasium.com/opennorth/scraperwiki-api-ruby.png)](https://gemnasium.com/opennorth/scraperwiki-api-ruby)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/opennorth/scraperwiki-api-ruby)
 
 ## Installation
 

data/USAGE

@@ -1 +1 @@
-See README.md for full usage details.
+See README.md for full usage details.

data/lib/scraperwiki-api.rb

@@ -7,9 +7,6 @@ module ScraperWiki
     include HTTParty
     base_uri 'api.scraperwiki.com/api/1.0'
 
-    class Error < StandardError; end
-    class ScraperNotFound < Error; end
-
     RUN_INTERVALS = {
       never: -1,
       monthly: 2678400,
@@ -79,8 +76,8 @@ module ScraperWiki
     # @param [Hash] opts optional arguments
     # @option opts [String] :format one of "jsondict", "jsonlist", "csv",
     #   "htmltable" or "rss2"
-    # @option opts [String] :attach ";"-delimited list of shortnames of other
-    #   scrapers whose data you need to access
+    # @option opts [Array,String] :attach ";"-delimited list of shortnames of
+    #   other scrapers whose data you need to access
     # @return [Array,Hash,String]
     # @see https://scraperwiki.com/docs/ruby/ruby_help_documentation/
     #
@@ -189,12 +186,13 @@ module ScraperWiki
     # @option opts [String] :version version number (-1 for most recent) [default -1]
     # @option opts [String] :history_start_date history and runevents are
     #   restricted to this date or after, enter as YYYY-MM-DD
-    # @option opts [String] :quietfields "|"-delimited list of fields to exclude
-    #   from the output. Must be a subset of 'code|runevents|datasummary|userroles|history'
+    # @option opts [Array,String] :quietfields "|"-delimited list of fields to
+    #   exclude from the output. Must be a subset of 'code|runevents|datasummary|userroles|history'
     # @return [Array]
     #
     # @note Returns an array although the array seems to always have only one item
     # @note The +tags+ field seems to always be an empty array
+    # @note Fields like +last_run+ seem to follow British Summer Time.
     # @note The query string parameter is +name+, not +shortname+
     #   {https://scraperwiki.com/docs/api#getinfo as in the ScraperWiki docs}
     def scraper_getinfo(shortname, opts = {})
@@ -318,8 +316,8 @@ module ScraperWiki
     # @param [Hash] opts optional arguments
     # @option opts [String] :searchquery search terms
     # @option opts [Integer] :maxrows number of results to return [default 5]
-    # @option opts [String] :nolist space-separated list of usernames to exclude
-    #   from the output
+    # @option opts [Array,String] :nolist space-separated list of usernames to
+    #   exclude from the output
     # @option opts [String] :requestinguser the name of the user making the
     #   search, which changes the order of the matches
     # @return [Array]

data/lib/scraperwiki-api/matchers.rb

@@ -1,4 +1,7 @@
+require 'time'
+
 require 'rspec'
+require 'yajl'
 
 module ScraperWiki
   class API
@@ -168,6 +171,68 @@ module ScraperWiki
         RunIntervalMatcher.new :never
       end
 
+      class LastRunMatcher < ScraperInfoMatcher
+        def months
+          @multiplier = 2592000 # 30 days
+          self
+        end
+        alias :month :months
+
+        def weeks
+          @multiplier = 604800
+          self
+        end
+        alias :week :weeks
+
+        def days
+          @multiplier = 86400
+          self
+        end
+        alias :day :days
+
+        def hours
+          @multiplier = 3600
+          self
+        end
+        alias :hour :hours
+
+        def minutes
+          @multiplier = 60
+          self
+        end
+        alias :minute :minutes
+
+        def seconds
+          @multiplier = 3600
+          self
+        end
+        alias :second :seconds
+
+        # @todo +last_run+ seems to follow British Summer Time, in which case it
+        #   will be +00, not +01, for part of the year.
+        def matches?(actual)
+          super
+          Time.now - Time.parse("#{@actual['last_run']}+01") < span
+        end
+
+        def span
+          @expected * (@multiplier || 1)
+        end
+
+        def failure_message
+          "expected #{@actual['short_name']} to have run within #{span} seconds"
+        end
+
+        def negative_failure_message
+          "expected #{@actual['short_name']} to not have run within #{span} seconds"
+        end
+      end
+      # @example
+      #   it {should have_run_within(7).days}
+      def have_run_within(expected)
+        LastRunMatcher.new expected
+      end
+
       class TablesMatcher < ScraperInfoMatcher
         def on(table)
           @table = table

data/lib/scraperwiki-api/version.rb

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

data/scraperwiki-api.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('yajl-ruby', '~> 1.0')
   s.add_runtime_dependency('httparty', '~> 0.8.0')
   s.add_development_dependency('rspec', '~> 2.10')
+  s.add_development_dependency('rake')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scraperwiki-api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-01 00:00:00.000000000 Z
+date: 2012-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70265218891100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70265218891100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70265218882020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,18 +37,44 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70265218882020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70265218880500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265218880500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby wrapper for the ScraperWiki API
 email:
 - info@opennorth.ca
@@ -52,6 +83,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -83,10 +115,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.12
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: The ScraperWiki API Ruby Gem
 test_files:
 - spec/scraperwiki-api_spec.rb
 - spec/spec_helper.rb
+has_rdoc: