festivals_lab 0.0.1

data/.rvmrc

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p327@festivalslab"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.17.0 (master)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    festivals_lab (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    ansi (1.4.3)
+    builder (3.2.2)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    hashie (2.0.5)
+    minitest (4.7.5)
+    minitest-reporters (0.14.20)
+      ansi
+      builder
+      minitest (>= 2.12, < 5.0)
+      powerbar
+    powerbar (1.0.11)
+      ansi (~> 1.4.0)
+      hashie (>= 1.1.0)
+    rake (10.0.2)
+    safe_yaml (0.9.5)
+    webmock (1.13.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  festivals_lab!
+  minitest-reporters
+  rake
+  webmock

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+end
+
+task :default => [:test]

data/festivals_lab.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/festivals_lab/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gareth Adams"]
+  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.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "festivals_lab"
+  gem.require_paths = ["lib"]
+  gem.version       = FestivalsLab::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'minitest-reporters'
+end

data/lib/festivals_lab.rb

@@ -0,0 +1,89 @@
+require 'json'
+require 'net/http'
+require 'openssl' # Provides HMAC-SHA1
+
+class FestivalsLab
+
+  attr_accessor :access_token, :access_key
+
+  SCHEME = "http"
+  HOST = "api.festivalslab.com"
+
+  def initialize access_token, access_key
+    @access_token = access_token
+    @access_key   = access_key
+  end
+
+  def events params = {}
+    params = params.dup
+
+    # Exact field options
+    valid_options = [:festival, :genre, :country, :code, :year]
+    # Fulltext search options
+    valid_options += [:title, :description, :artist]
+    # Event date options
+    valid_options += [:date_from, :date_to]
+    # Venue options
+    valid_options += [:venue_name, :venue_code, :post_code, :distance, :lat, :lng]
+    # Price options
+    valid_options += [:price_from, :price_to]
+    # Update options
+    valid_options += [:modified_from]
+    # Pagination options
+    valid_options += [:size, :from]
+
+    invalid_keys = params.reject { |k,v| valid_options.include? k }.keys
+
+    raise ArgumentError, "Unexpected events parameter: #{invalid_keys.join ", "}" if invalid_keys.any?
+
+    request '/events', params
+  end
+
+  def request endpoint, params = {}
+    uri = signed_uri endpoint, params
+    Net::HTTP.start(uri.host, uri.port) do |http|
+      request = Net::HTTP::Get.new uri.request_uri
+      request['Accept'] = 'application/json'
+      response = http.request request
+      if Net::HTTPSuccess === response
+        JSON.parse(response.body)
+      else
+        raise ApiError.new(response)
+      end
+    end
+  end
+
+  def signed_uri endpoint, params = {}
+    params = params.dup
+    raise Error, "Missing API access key" unless access_key
+    raise Error, "Missing API access token" unless access_token
+    # Start with a generic URI representing just the path
+    # This is convenient because the URI represents the string which gets signed
+    uri = URI(endpoint)
+
+    params[:key] = access_token
+    uri.query = URI.encode_www_form(params)
+
+    params[:signature] = self.signature uri.to_s
+    uri.query = URI.encode_www_form(params)
+
+    uri.scheme = SCHEME
+    uri.host   = HOST
+    # Now the URI has a scheme we can convert it to an actual URI::HTTP
+    URI.parse(uri.to_s)
+  end
+
+  def signature url
+    OpenSSL::HMAC.hexdigest 'sha1', access_key, url
+  end
+
+  Error = Class.new(StandardError)
+  ArgumentError = Class.new(::ArgumentError)
+  ApiError = Class.new(StandardError) do
+    attr_reader :response
+
+    def initialize response
+      @response = response
+    end
+  end
+end

data/lib/festivals_lab/version.rb

@@ -0,0 +1,3 @@
+class FestivalsLab
+  VERSION = "0.0.1"
+end

data/test/lib/test_festivals_lab.rb

@@ -0,0 +1,144 @@
+require 'test_helper'
+
+require 'minitest/spec'
+require 'webmock/minitest'
+
+require 'festivals_lab'
+
+describe FestivalsLab do
+
+  before do
+    @api = FestivalsLab.new '123', '456'
+    @successful_response = { status: 200, body: "[{}]", headers: { 'Content-Type' => 'application/json' } }
+    @failed_response = { status: 403, body: "", headers: { 'Content-Type' => 'application/json' } }
+  end
+
+  it "has a VERSION" do
+    FestivalsLab.constants.must_include :VERSION
+  end
+
+  describe "#initialize" do
+    it "sets an access token" do
+      api = FestivalsLab.new "123", nil
+
+      api.access_token.must_equal "123"
+    end
+
+    it "sets an access key" do
+      api = FestivalsLab.new nil, "456"
+
+      api.access_key.must_equal "456"
+    end
+  end
+
+  describe "#events" do
+    [:festival, :genre, :country, :code, :year, :title, :description, :artist, :venue_name, :post_code, :distance].each do |param|
+      it "allows a string '#{param}' parameter" do
+        stub = stub_http_request(:get, %r{//api\.festivalslab\.com/events})
+          .with(query: hash_including(param => 'value'))
+          .to_return(@successful_response)
+
+        @api.events param => 'value'
+
+        assert_requested(stub)
+      end
+    end
+
+    [:venue_code, :price_from, :price_to, :size, :from, :lat, :lng].each do |param|
+      it "allows a numeric '#{param}' parameter" do
+        stub = stub_http_request(:get, %r{//api\.festivalslab\.com/events})
+          .with(query: hash_including(param => '42'))
+          .to_return(@successful_response)
+
+        @api.events param => 42
+
+        assert_requested(stub)
+      end
+    end
+
+    [:date_from, :date_to, :modified_from].each do |param|
+      it "allows a date '#{param}' parameter" do
+        stub = stub_http_request(:get, %r{//api\.festivalslab\.com/events})
+          .with(query: hash_including(param => '1970-01-01 01:00:00'))
+          .to_return(@successful_response)
+
+        @api.events param => Time.at(0).strftime("%F %T")
+
+        assert_requested(stub)
+      end
+    end
+
+    it "returns parsed events" do
+      stub = stub_http_request(:get, %r{//api\.festivalslab\.com/events})
+        .to_return(@successful_response)
+
+      response = @api.events
+
+      assert_equal [{}], response
+    end
+
+    it "rejects invalid parameters" do
+      lambda {
+        @api.events foobar: 42
+      }.must_raise(FestivalsLab::ArgumentError, "Unexpected events parameter: foobar")
+    end
+  end
+
+  describe "#request" do
+    before do
+      @uri = "http://api.festivalslab.com/events?key=123&signature=742969faae86a4ba4223c7d93d05ead4b1397c23"
+    end
+
+    it "makes a request to the signed endpoint URI" do
+      stub_request(:get, @uri).to_return(@successful_response)
+
+      @api.request '/events'
+
+      assert_requested(:get, @uri)
+    end
+
+    it "parses the response as JSON" do
+      stub = stub_http_request(:get, @uri)
+        .to_return(@successful_response)
+
+      response = @api.request '/events'
+
+      assert_equal [{}], response
+    end
+
+    it "raises FestivalsLab::ApiError on unsuccessful HTTP request" do
+      stub = stub_http_request(:get, @uri)
+        .to_return(@failed_response)
+
+      lambda { @api.request '/events' }.must_raise(FestivalsLab::ApiError)
+    end
+  end
+
+  describe "#signed_uri" do
+    it "requires an access key to be set" do
+      @api.access_key = nil
+      lambda { @api.signed_uri('/events') }.must_raise(FestivalsLab::Error, "Missing API access key")
+    end
+
+    it "requires an access token to be set" do
+      @api.access_token = nil
+      lambda { @api.signed_uri('/events') }.must_raise(FestivalsLab::Error, "Missing API access token")
+    end
+
+    it "appends the correct signature to the request URI" do
+      uri = @api.signed_uri('/events', {:key => 123})
+      uri.must_be_kind_of(URI)
+      uri.to_s.must_equal 'http://api.festivalslab.com/events?key=123&signature=742969faae86a4ba4223c7d93d05ead4b1397c23'
+    end
+  end
+
+  describe "#signature" do
+    it "calculates the HMAC-SHA1 signature based on the access key" do
+      ## Because `OpenSSL#HMAC.hexdigest('sha1', '456', '/events?key=123')` # => '742969faae86a4ba4223c7d93d05ead4b1397c23'
+      @api.signature('/events?key=123').must_equal '742969faae86a4ba4223c7d93d05ead4b1397c23'
+    end
+  end
+
+end
+
+

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+MiniTest::Reporters.use!

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: festivals_lab
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gareth Adams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-14 00:00:00.000000000 Z
+dependencies:
+- !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: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Accesses festival data from the Edinburgh Festivals Innovation Lab API
+email:
+- g@rethada.ms
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- festivals_lab.gemspec
+- lib/festivals_lab.rb
+- lib/festivals_lab/version.rb
+- test/lib/test_festivals_lab.rb
+- test/test_helper.rb
+homepage: http://festivalslab.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2264928236337400198
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2264928236337400198
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: 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
+test_files:
+- test/lib/test_festivals_lab.rb
+- test/test_helper.rb