festivals_lab 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    festivals_lab (0.0.2)
+    festivals_lab (0.0.3)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -4,10 +4,12 @@ An unofficial library to access festival data from the Edinburgh Festivals Innov
 
 ## Description ##
 
-Festivals Lab is an open data initiative which provides free access to the events of the 12 annual Edinburgh festivals.
+[Festivals Lab][festivalslab] is an open data initiative which provides free access to the events of the 12 annual Edinburgh festivals.
 
 The `festivals_lab` gem wraps the API and ties it with a Ruby bow
 
+  [festivalslab]: http://festivalslab.com/
+
 ## Compatibility ##
 
 * As an alpha, `festivals_lab` is only developed and tested against Ruby 1.9.3 (other rubies should work, but run the tests first).
@@ -38,7 +40,7 @@ The parameters for library method calls match the [official documentation][query
 * The library exclusively requests JSON responses from the API, and the `pretty` parameter is invalid.
 
   [gettingstarted]: http://api.festivalslab.com/documentation#gettingstarted
-  [querying]: http://api.festivalslab.com/documentation#Querying the API
+  [querying]: http://api.festivalslab.com/documentation#Querying%20the%20API
 
 ### Sample usage ###
 

data/festivals_lab.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["g@rethada.ms"]
   gem.description   = %q{Accesses festival data from the Edinburgh Festivals Innovation Lab API}
   gem.summary       = %q{The Edinburgh Festivals API is an ambitious project which aims to create open access to the event listings data of Edinburgh’s 12 major Festivals}
-  gem.homepage      = "http://festivalslab.com/"
+  gem.homepage      = "https://github.com/gareth/festivals_lab"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/festivals_lab/version.rb

@@ -1,3 +1,3 @@
 class FestivalsLab
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/festivals_lab.rb

@@ -14,6 +14,11 @@ class FestivalsLab
     @secret_token = secret_token
   end
 
+  # Searches the API for events matching the given `params`
+  #
+  # See the API documentation at
+  # http://api.festivalslab.com/documentation#Querying%20the%20API for valid
+  # parameters
   def events params = {}
     params = params.dup
 
@@ -39,11 +44,18 @@ class FestivalsLab
     FestivalsLab.request access_key, secret_token, '/events', params
   end
 
+  # Returns the known data for an event based on the event's UUID
+  #
+  # The only way to obtain the UUID for an event is to extract it from the
+  # `url` property returned by the `events` endpoint
   def event uuid
     FestivalsLab.request access_key, secret_token, "/event/#{uuid}"
   end
 
   class << self
+    # Makes a signed API request to the given endpoint
+    #
+    # Requests the data in JSON format and parses the response as JSON
     def request access_key, secret_token, endpoint, params = {}
       uri = FestivalsLab.signed_uri access_key, secret_token, endpoint, params
       Net::HTTP.start(uri.host, uri.port) do |http|
@@ -58,6 +70,8 @@ class FestivalsLab
       end
     end
 
+    # Returns a URI containing the correct signature for the given endpoint and
+    # query string parameters
     def signed_uri access_key, secret_token, endpoint, params = {}
       params = params.dup
       raise Error, "Missing API access key" unless access_key
@@ -78,12 +92,12 @@ class FestivalsLab
       URI.parse(uri.to_s)
     end
 
+    # Returns the correct API signature for the given URL and secret token
     def signature secret_token, url
       OpenSSL::HMAC.hexdigest 'sha1', secret_token, url
     end
   end
 
-
   Error = Class.new(StandardError)
   ArgumentError = Class.new(::ArgumentError)
   ApiError = Class.new(StandardError) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: festivals_lab
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-14 00:00:00.000000000 Z
+date: 2013-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -79,7 +79,7 @@ files:
 - lib/festivals_lab/version.rb
 - test/lib/test_festivals_lab.rb
 - test/test_helper.rb
-homepage: http://festivalslab.com/
+homepage: https://github.com/gareth/festivals_lab
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -93,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4234472854470534461
+      hash: -3698572132411797010
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4234472854470534461
+      hash: -3698572132411797010
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24