booking_locations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5c8b877898b03f793be9ff7adfacfbb796c7698
+  data.tar.gz: e9f6eeafb705f4cec736f0783d3d5d5a89902fb4
+SHA512:
+  metadata.gz: 886c119dafaac5dc0941b7681b7656b87782aa7cd045f77c9d65e855738a4bdfbe88e2c45059be442e701bcbf73eb8da98713d1fa0f9b8c7d5f522b245c615c5
+  data.tar.gz: 41c894aa5ef2cb841759654f017e272d7ac916ca866152290e508f5f892aaeb416d417cc64b508de8e88f48e38e5b612a9589e8232e1b708d5594a4290ab493a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in booking_locations.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ben Lovell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# BookingLocations
+
+Provides Booking Locations API access.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'booking_locations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install booking_locations
+
+## Usage
+
+```ruby
+
+BookingLocations.find(id) # returns a Location or nil
+
+```
+
+The library provides a stubbed adapter:
+
+```ruby
+
+require 'booking_locations/stub_api'
+BookingLocations.api = BookingLocations::StubApi.new
+
+```
+
+This returns canned responses for locations within Hackney.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/guidance-guarantee-programme/booking_locations.
+
+
+## License
+
+The gem is available as open source under the terms of the 
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "booking_locations"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/booking_locations.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'booking_locations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'booking_locations'
+  spec.version       = BookingLocations::VERSION
+  spec.authors       = ['Ben Lovell']
+  spec.email         = ['benjamin.lovell@gmail.com']
+
+  spec.summary       = 'Pension Guidance Booking Locations API adapter'
+  spec.homepage      = 'https://github.com/guidance-guarantee-programme/booking_locations'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '>= 4', '< 5.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+end

data/lib/booking_locations/api.rb

@@ -0,0 +1,33 @@
+require 'open-uri'
+
+module BookingLocations
+  class Api
+    def get(id)
+      response = open("#{api_uri}/api/v1/booking_locations/#{id}.json", headers_and_options)
+      yield JSON.parse(response.read)
+    rescue OpenURI::HTTPError, Net::ReadTimeout
+      nil
+    end
+
+    private
+
+    def headers_and_options
+      {}.tap do |hash|
+        hash[:read_timeout]   = read_timeout
+        hash['Authorization'] = "Bearer #{bearer_token}" if bearer_token
+      end
+    end
+
+    def bearer_token
+      ENV['BOOKING_LOCATIONS_API_BEARER_TOKEN']
+    end
+
+    def api_uri
+      ENV.fetch('BOOKING_LOCATIONS_API_URI', 'http://localhost:3001')
+    end
+
+    def read_timeout
+      ENV.fetch('BOOKING_LOCATIONS_API_READ_TIMEOUT', 5).to_i
+    end
+  end
+end

data/lib/booking_locations/location.rb

@@ -0,0 +1,41 @@
+require 'ostruct'
+
+module BookingLocations
+  class Location
+    def initialize(data)
+      @data = data
+    end
+
+    def id
+      @data['uid']
+    end
+
+    def name
+      @data['name']
+    end
+
+    def address
+      @data['address']
+    end
+
+    def locations
+      @locations ||= @data['locations'].map { |child_data| Location.new(child_data) }
+    end
+
+    def guiders
+      @guiders ||= @data['guiders'].map { |guider| OpenStruct.new(guider) }
+    end
+
+    def slots
+      @slots ||= @data['slots'].map { |slot| Slot.new(slot) }
+    end
+
+    def name_for(location_id)
+      if id == location_id
+        name
+      else
+        locations.find { |location| location.id == location_id }.name
+      end
+    end
+  end
+end

data/lib/booking_locations/slot.rb

@@ -0,0 +1,17 @@
+require 'ostruct'
+
+module BookingLocations
+  class Slot < OpenStruct
+    def to_calendar
+      ["#{calendar_date} - #{period}", "#{date}-#{start}-#{self.end}"]
+    end
+
+    def calendar_date
+      Date.parse(date).strftime('%A, %b %e')
+    end
+
+    def period
+      start == '0900' ? 'Morning' : 'Afternoon'
+    end
+  end
+end

data/lib/booking_locations/stub_api.json

@@ -0,0 +1,341 @@
+{
+  "uid": "ac7112c3-e3cf-45cd-a8ff-9ba827b8e7ef",
+  "name": "Hackney",
+  "address": "300 Mare St, HACKNEY, London, E8 1HE",
+  "locations": [
+    {
+      "uid": "183080c6-642b-4b8f-96fd-891f5cd9f9c7",
+      "name": "Dalston",
+      "address": "22 Dalston Lane, Hackney, London, E8 3AZ"
+    },
+    {
+      "uid": "1a1ad00f-d967-448a-a4a6-772369fa5087",
+      "name": "Tower Hamlets",
+      "address": "32 Greatorex Street, TOWER HAMLETS, London, E1 5NP"
+    },
+    {
+      "uid": "c165d25e-f27b-4ce9-b3d3-e7415ebaa93c",
+      "name": "Haringey",
+      "address": "551B Tottenham High Road, HARINGEY, London, N17 6SB"
+    },
+    {
+      "uid": "a77a031a-8037-4510-b1f7-63d4aab7b103",
+      "name": "Waltham Forest",
+      "address": "220 Hoe Street, Walthamstow, London, E17 3AY"
+    }
+  ],
+  "guiders": [
+    {
+      "id": 1,
+      "name": "Ben Lovell",
+      "email": "ben@example.com"
+    },
+    {
+      "id": 2,
+      "name": "Jenny Smith",
+      "email": "jenny@example.com"
+    },
+    {
+      "id": 3,
+      "name": "Bob Johnson",
+      "email": "bob@example.com"
+    },
+    {
+      "id": 4,
+      "name": "Janice Jones",
+      "email": "janice@example.com"
+    }
+  ],
+  "slots": [
+    {
+      "date": "2016-06-20",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-06-20",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-06-21",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-06-21",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-06-22",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-06-22",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-06-23",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-06-23",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-06-24",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-06-24",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-06-27",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-06-27",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-06-28",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-06-28",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-06-29",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-06-29",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-06-30",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-06-30",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-01",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-01",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-04",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-04",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-05",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-05",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-06",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-06",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-07",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-07",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-08",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-08",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-11",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-11",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-12",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-12",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-13",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-13",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-14",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-14",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-15",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-15",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-18",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-18",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-19",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-19",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-20",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-20",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-21",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-21",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-22",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-22",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-25",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-25",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-26",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-26",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-27",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-27",
+      "start": "1300",
+      "end": "1700"
+    },
+    {
+      "date": "2016-07-28",
+      "start": "0900",
+      "end": "1300"
+    },
+    {
+      "date": "2016-07-28",
+      "start": "1300",
+      "end": "1700"
+    }
+  ]
+}

data/lib/booking_locations/stub_api.rb

@@ -0,0 +1,17 @@
+module BookingLocations
+  KNOWN_LOCATION_IDS = %w(
+    ac7112c3-e3cf-45cd-a8ff-9ba827b8e7ef
+    183080c6-642b-4b8f-96fd-891f5cd9f9c7
+    c165d25e-f27b-4ce9-b3d3-e7415ebaa93c
+    a77a031a-8037-4510-b1f7-63d4aab7b103
+  ).freeze
+
+  class StubApi
+    def get(id)
+      return nil unless KNOWN_LOCATION_IDS.include?(id)
+
+      contents = IO.read(File.join(File.dirname(File.expand_path(__FILE__)), 'stub_api.json'))
+      yield JSON.parse(contents)
+    end
+  end
+end

data/lib/booking_locations/version.rb

@@ -0,0 +1,3 @@
+module BookingLocations
+  VERSION = '0.1.0'.freeze
+end

data/lib/booking_locations.rb

@@ -0,0 +1,20 @@
+require 'booking_locations/version'
+require 'booking_locations/api'
+require 'booking_locations/slot'
+require 'booking_locations/location'
+
+require 'active_support/core_ext/module/attribute_accessors'
+
+module BookingLocations
+  mattr_writer :api
+
+  def self.api
+    @@api ||= BookingLocations::Api.new
+  end
+
+  def self.find(id)
+    api.get(id) do |response_hash|
+      Location.new(response_hash)
+    end
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: booking_locations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Lovell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 
+email:
+- benjamin.lovell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- booking_locations.gemspec
+- lib/booking_locations.rb
+- lib/booking_locations/api.rb
+- lib/booking_locations/location.rb
+- lib/booking_locations/slot.rb
+- lib/booking_locations/stub_api.json
+- lib/booking_locations/stub_api.rb
+- lib/booking_locations/version.rb
+homepage: https://github.com/guidance-guarantee-programme/booking_locations
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Pension Guidance Booking Locations API adapter
+test_files: []