festivals_lab 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67ea9c76f6dc42686fa5a358c73c565139b8408a
+  data.tar.gz: 79bcb08ca6fbcc5c3573a492e87ffb796091d039
+SHA512:
+  metadata.gz: 11f091bde049e598408cd1abaa5be80e48c8cba1547e0fbbd60330f5d56f87e2fa3952cafb42e95b63dae4b2733b447b1b6fff319ceaed18e0b36e38b92d73d9
+  data.tar.gz: 6b1154567e1ca0707ebf74cb6657c50ec24857b85e058ceefb659567c0fa7748b4f60fdab693889bea108bfa61dff80cb0267d282a16858340b4da269f377dd9

data/.rubocop.yml

@@ -0,0 +1,49 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+# Relates to the indentation of if/when/(etc.) blocks when the initial keyword
+# is indented as part of a variable assignment.
+#
+# Our preference is that the rubocop default conflicts with our 80-character
+# line restriction, leaving less space for code inside nested blocks. We make
+# this change at the cost of a little bit of readability.
+#
+#     # bad (although the Rubocop default):
+#     thing = if x > 42
+#               thing!
+#             else
+#               other_thing!
+#             end
+#
+#     # good (preferred):
+#     thing = if x > 42
+#       thing!
+#     else
+#       other_thing!
+#     end
+#
+#     # also acceptable
+#     thing =
+#       if x > 42
+#         thing!
+#       else
+#         other_thing!
+#       end
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+# Passing multiple hashes to a function is messy, and clarity is good
+# This is an extension of https://github.com/bbatsov/ruby-style-guide#no-braces-opts-hash
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+  StyleGuide: https://github.com/bbatsov/rubocop/issues/801
+
+# This is one part of the style guide that doesn't express a preference, it just
+# suggests you make a choice
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  StyleGuide: https://www.viget.com/articles/just-use-double-quoted-ruby-strings

data/Gemfile

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

data/Gemfile.lock

@@ -1,31 +1,32 @@
 PATH
   remote: .
   specs:
-    festivals_lab (0.0.3)
+    festivals_lab (0.0.4)
 
 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)
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    ansi (1.5.0)
+    builder (3.2.3)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    hashdiff (0.3.2)
+    minitest (5.10.1)
+    minitest-reporters (1.1.14)
       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)
+      minitest (>= 5.0)
+      ruby-progressbar
+    public_suffix (2.0.5)
+    rake (12.0.0)
+    ruby-progressbar (1.8.1)
+    safe_yaml (1.0.4)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
       crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
@@ -35,3 +36,6 @@ DEPENDENCIES
   minitest-reporters
   rake
   webmock
+
+BUNDLED WITH
+   1.14.6

data/Rakefile

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

data/festivals_lab.gemspec

@@ -1,21 +1,22 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/festivals_lab/version', __FILE__)
+
+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.description   = "Accesses festival data from the Edinburgh Festivals Innovation Lab API"
+  gem.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"
   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) }
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  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'
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "minitest-reporters"
 end

data/lib/festivals_lab.rb

@@ -1,15 +1,14 @@
-require 'json'
-require 'net/http'
-require 'openssl' # Provides HMAC-SHA1
+require "json"
+require "net/http"
+require "openssl" # Provides HMAC-SHA1
 
 class FestivalsLab
-
   attr_accessor :access_key, :secret_token
 
-  SCHEME = "http"
-  HOST = "api.festivalslab.com"
+  SCHEME = "http".freeze
+  HOST = "api.edinburghfestivalcity.com".freeze
 
-  def initialize access_key, secret_token
+  def initialize(access_key, secret_token)
     @access_key   = access_key
     @secret_token = secret_token
   end
@@ -19,36 +18,36 @@ class FestivalsLab
   # See the API documentation at
   # http://api.festivalslab.com/documentation#Querying%20the%20API for valid
   # parameters
-  def events params = {}
+  def events(params = {})
     params = params.dup
 
     # Exact field options
-    valid_options = [:festival, :genre, :country, :code, :year]
+    valid_options = %i[festival genre country code year]
     # Fulltext search options
-    valid_options += [:title, :description, :artist]
+    valid_options += %i[title description artist]
     # Event date options
-    valid_options += [:date_from, :date_to]
+    valid_options += %i[date_from date_to]
     # Venue options
-    valid_options += [:venue_name, :venue_code, :post_code, :distance, :lat, :lng]
+    valid_options += %i[venue_name venue_code post_code distance lat lng]
     # Price options
-    valid_options += [:price_from, :price_to]
+    valid_options += %i[price_from price_to]
     # Update options
     valid_options += [:modified_from]
     # Pagination options
-    valid_options += [:size, :from]
+    valid_options += %i[size from]
 
-    invalid_keys = params.reject { |k,v| valid_options.include? k }.keys
+    invalid_keys = params.reject { |k, _v| valid_options.include? k }.keys
 
-    raise ArgumentError, "Unexpected events parameter: #{invalid_keys.join ", "}" if invalid_keys.any?
+    raise ArgumentError, "Unexpected events parameter: #{invalid_keys.join ', '}" if invalid_keys.any?
 
-    FestivalsLab.request access_key, secret_token, '/events', params
+    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
+  def event(uuid)
     FestivalsLab.request access_key, secret_token, "/event/#{uuid}"
   end
 
@@ -56,23 +55,23 @@ class FestivalsLab
     # 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 = {}
+    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|
         request = Net::HTTP::Get.new uri.request_uri
-        request['Accept'] = 'application/json'
+        request["Accept"] = "application/json"
         response = http.request request
         if Net::HTTPSuccess === response
           JSON.parse(response.body)
         else
-          raise ApiError.new(response)
+          raise ApiError, response
         end
       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 = {}
+    def signed_uri(access_key, secret_token, endpoint, params = {})
       params = params.dup
       raise Error, "Missing API access key" unless access_key
       raise Error, "Missing API secret token" unless secret_token
@@ -93,8 +92,8 @@ class FestivalsLab
     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
+    def signature(secret_token, url)
+      OpenSSL::HMAC.hexdigest "sha1", secret_token, url
     end
   end
 
@@ -103,7 +102,7 @@ class FestivalsLab
   ApiError = Class.new(StandardError) do
     attr_reader :response
 
-    def initialize response
+    def initialize(response)
       @response = response
     end
   end

data/lib/festivals_lab/version.rb

@@ -1,3 +1,3 @@
 class FestivalsLab
-  VERSION = "0.0.3"
+  VERSION = "0.0.4".freeze
 end

data/test/lib/test_festivals_lab.rb

@@ -1,16 +1,15 @@
-require 'test_helper'
+require "test_helper"
 
-require 'minitest/spec'
-require 'webmock/minitest'
+require "minitest/spec"
+require "webmock/minitest"
 
-require 'festivals_lab'
+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' } }
+    @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
@@ -32,23 +31,23 @@ describe FestivalsLab do
   end
 
   describe "#events" do
-    [:festival, :genre, :country, :code, :year, :title, :description, :artist, :venue_name, :post_code, :distance].each do |param|
+    %i[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)
+        stub = stub_http_request(:get, %r{//api\.edinburghfestivalcity\.com/events}).
+               with(query: hash_including(param => "value")).
+               to_return(@successful_response)
 
-        @api.events param => 'value'
+        @api.events param => "value"
 
         assert_requested(stub)
       end
     end
 
-    [:venue_code, :price_from, :price_to, :size, :from, :lat, :lng].each do |param|
+    %i[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)
+        stub = stub_http_request(:get, %r{//api\.edinburghfestivalcity\.com/events}).
+               with(query: hash_including(param => "42")).
+               to_return(@successful_response)
 
         @api.events param => 42
 
@@ -56,11 +55,11 @@ describe FestivalsLab do
       end
     end
 
-    [:date_from, :date_to, :modified_from].each do |param|
+    %i[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)
+        stub = stub_http_request(:get, %r{//api\.edinburghfestivalcity\.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")
 
@@ -69,8 +68,8 @@ describe FestivalsLab do
     end
 
     it "returns parsed events" do
-      stub = stub_http_request(:get, %r{//api\.festivalslab\.com/events})
-        .to_return(@successful_response)
+      stub_http_request(:get, %r{//api\.edinburghfestivalcity\.com/events}).
+        to_return(@successful_response)
 
       response = @api.events
 
@@ -86,19 +85,19 @@ describe FestivalsLab do
 
   describe "#event" do
     it "requests the event from the API" do
-      stub = stub_http_request(:get, %r{//api\.festivalslab\.com/event/00000000000000000000000000000000deadbeef})
-        .to_return(@successful_response)
+      stub = stub_http_request(:get, %r{//api\.edinburghfestivalcity\.com/event/00000000000000000000000000000000deadbeef}).
+             to_return(@successful_response)
 
-      response = @api.event '00000000000000000000000000000000deadbeef'
+      @api.event "00000000000000000000000000000000deadbeef"
 
       assert_requested(stub)
     end
 
     it "returns the parsed event" do
-      stub = stub_http_request(:get, %r{//api\.festivalslab\.com/event/00000000000000000000000000000000deadbeef})
-        .to_return(@successful_response)
+      stub_http_request(:get, %r{//api\.edinburghfestivalcity\.com/event/00000000000000000000000000000000deadbeef}).
+        to_return(@successful_response)
 
-      response = @api.event '00000000000000000000000000000000deadbeef'
+      response = @api.event "00000000000000000000000000000000deadbeef"
 
       assert_equal [{}], response
     end
@@ -106,59 +105,56 @@ describe FestivalsLab do
 
   describe "request" do
     before do
-      @uri = "http://api.festivalslab.com/events?key=123&signature=742969faae86a4ba4223c7d93d05ead4b1397c23"
+      @uri = "http://api.edinburghfestivalcity.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)
 
-      FestivalsLab.request @api.access_key, @api.secret_token, '/events'
+      FestivalsLab.request @api.access_key, @api.secret_token, "/events"
 
       assert_requested(:get, @uri)
     end
 
     it "parses the response as JSON" do
-      stub = stub_http_request(:get, @uri)
-        .to_return(@successful_response)
+      stub_http_request(:get, @uri).
+        to_return(@successful_response)
 
-      response = FestivalsLab.request @api.access_key, @api.secret_token, '/events'
+      response = FestivalsLab.request @api.access_key, @api.secret_token, "/events"
 
       assert_equal [{}], response
     end
 
     it "raises FestivalsLab::ApiError on unsuccessful HTTP request" do
-      stub = stub_http_request(:get, @uri)
-        .to_return(@failed_response)
+      stub_http_request(:get, @uri).
+        to_return(@failed_response)
 
-      lambda { FestivalsLab.request @api.access_key, @api.secret_token, '/events' }.must_raise(FestivalsLab::ApiError)
+      -> { FestivalsLab.request @api.access_key, @api.secret_token, "/events" }.must_raise(FestivalsLab::ApiError)
     end
   end
 
   describe "signed_uri" do
     it "requires an access key to be set" do
       @api.secret_token = nil
-      lambda { FestivalsLab.signed_uri(@api.access_key, @api.secret_token, '/events') }.must_raise(FestivalsLab::Error, "Missing API access key")
+      -> { FestivalsLab.signed_uri(@api.access_key, @api.secret_token, "/events") }.must_raise(FestivalsLab::Error, "Missing API access key")
     end
 
     it "requires an access token to be set" do
       @api.access_key = nil
-      lambda { FestivalsLab.signed_uri(@api.access_key, @api.secret_token, '/events') }.must_raise(FestivalsLab::Error, "Missing API access token")
+      -> { FestivalsLab.signed_uri(@api.access_key, @api.secret_token, "/events") }.must_raise(FestivalsLab::Error, "Missing API access token")
     end
 
     it "appends the correct signature to the request URI" do
-      uri = FestivalsLab.signed_uri(@api.access_key, @api.secret_token, '/events', {:key => 123})
+      uri = FestivalsLab.signed_uri(@api.access_key, @api.secret_token, "/events", key: 123)
       uri.must_be_kind_of(URI)
-      uri.to_s.must_equal 'http://api.festivalslab.com/events?key=123&signature=742969faae86a4ba4223c7d93d05ead4b1397c23'
+      uri.to_s.must_equal "http://api.edinburghfestivalcity.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'
-      FestivalsLab.signature(@api.secret_token, '/events?key=123').must_equal '742969faae86a4ba4223c7d93d05ead4b1397c23'
+      FestivalsLab.signature(@api.secret_token, "/events?key=123").must_equal "742969faae86a4ba4223c7d93d05ead4b1397c23"
     end
   end
-
 end
-
-

data/test/test_helper.rb

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

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: festivals_lab
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Gareth Adams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2017-04-17 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
@@ -66,8 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
+- ".gitignore"
+- ".rubocop.yml"
+- ".rvmrc"
 - CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
@@ -81,33 +75,26 @@ files:
 - test/test_helper.rb
 homepage: https://github.com/gareth/festivals_lab
 licenses: []
+metadata: {}
 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: -3698572132411797010
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3698572132411797010
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 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: