uclapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 716074106efd9792d163ac49f318fcaf3857c6e0
+  data.tar.gz: 0da5d447127341afc94a7c56259a49e722bb43af
+SHA512:
+  metadata.gz: 99739a426c9483c75369184425c535994b9168c5222113ed883f81b5efe7adf57aded07b8d99fc521e6db388d9a69c295b63fb269367c60119373be28fee42f2
+  data.tar.gz: 7daba28081ab1a022db89ca93dbf8745bfdd8aa441c0190425dda5c010bd698598a11fd6004a4ac6598db72fc3c00feefa20b5353d0df31189fc795bcfbbbd88

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+  - latest
+before_install: gem install bundler -v 1.16.0.pre.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cristiano@betta.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    uclapi (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.8.0)
+  bundler (~> 1.16.a)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  uclapi!
+
+BUNDLED WITH
+   1.16.0.pre.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Cristiano Betta
+
+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,184 @@
+# Ruby API library for the UCL API
+
+[![Gem Version](https://badge.fury.io/rb/uclapi.svg)](https://badge.fury.io/rb/uclapi) [![Build Status](https://travis-ci.org/cbetta/uclapi.svg?branch=master)](https://travis-ci.org/cbetta/uclapi)
+
+A wrapper for the [UCL API](https://uclapi.com/). Specification is as described in the the [developer documentation](https://docs.uclapi.com/).
+
+## Installation
+
+Either install directly or via bundler.
+
+```rb
+gem 'uclapi'
+```
+
+## Getting started
+
+The client will accept the app token either as a parameter on initialization,
+or as an environment variable. Additionally a `debug` parameter can be set to enable verbose debugging.
+
+```rb
+require 'uclapi'
+
+# using parameters
+client = UCLAPI::Client.new(token: '...')
+
+# using environment variables:
+# * UCLAPI_TOKEN
+client = UCLAPI::Client.new
+```
+
+The client provides with direct access to every API call as documented in the
+developer documentation. Additionally it also provides some convenience methods.
+
+```rb
+# get a room
+room = client.roombookings.rooms.first
+# get the bookings for a room
+bookings = room.bookings
+# get the equipment for a room
+equipment = room.equipment
+```
+
+## Convenience methods
+
+### `room.bookings`
+
+Maps to `client.roombookings.bookings` and passes along all the
+same parameters while automatically setting the `roomid` and `siteid`.
+
+### `room.equipment`
+
+Maps to `client.roombookings.equipment` and passes along all the
+same parameters while automatically setting the `roomid` and `siteid`.
+
+### `booking.room`
+
+Maps to `client.roombookings.room` and passes along the `roomid` and `siteid`.
+
+### `equipment.room`
+
+Maps to `client.roombookings.room` and passes along the `roomid` and `siteid`.
+
+
+## API
+
+### `GET /roombookings/rooms`
+
+This endpoint returns rooms and information about them. If you don’t specify any query parameters besides the token, all rooms will be returned.
+
+More: [Documentation](https://docs.uclapi.com/#get-rooms)
+
+```rb
+> rooms = client.roombookings.rooms
+[#<UCLAPI::Room siteid="123" ....>, #<UCLAPI::Room siteid="123" ....>]
+> rooms.first
+UCLAPI::Room {
+            :siteid => "123",
+          :location => {
+        "coordinates" => {
+            "lat" => "51.523504",
+            "lng" => "-0.134937"
+        },
+            "address" => [
+            [0] "74 Huntley Street",
+            [1] "London",
+            [2] "WC1E 6AU",
+            [3] ""
+        ]
+
+    },
+            :roomid => "234",
+          :sitename => "Medical School Building",
+          :roomname => "Rockefeller Building 335",
+         :automated => "P",
+          :capacity => 20,
+    :classification => "CR"
+}
+# optional provide any extra parameters
+> rooms = client.roombookings.rooms(siteid: 123)
+```
+
+### `GET /roombookings/bookings`
+
+This endpoint shows the results to a bookings or space availability query. It returns a paginated list of bookings.
+
+More: [Documentation](https://docs.uclapi.com/#get-bookings)
+
+```rb
+> bookings = client.roombookings.bookings
+[#<UCLAPI::Booking slotid="1234567" ....>, ...]
+> bookings.first
+UCLAPI::Booking {
+         :siteid => "123",
+       :end_time => "2018-02-01T12:00:00+00:00",
+         :roomid => "456",
+         :slotid => 1234567,
+          :phone => nil,
+       :roomname => "IOE - Bedford Way (20) - 790",
+     :start_time => "2018-02-01T11:00:00+00:00",
+        :contact => "Mr John Doe",
+    :description => "Introduction to The UCL API",
+     :weeknumber => 23.0
+}
+# optional provide any extra parameters
+> rooms = client.roombookings.bookings(siteid: 374)
+```
+
+### `GET /roombookings/equipment`
+
+This endpoint returns any equipment/feature information about a specific room. So, for example whether there is a Whiteboard or a DVD Player in the room.
+
+More: [Documentation](https://docs.uclapi.com/#get-equipment)
+
+```rb
+> equipment = client.roombookings.equipment(siteid: 123, roomid: 345)
+[#<UCLAPI::Equipment description="White Board" ....>, ...]
+> equipment.first
+UCLAPI::Equipment {
+    :description => "White Board",
+           :type => "FF",
+          :units => 1,
+         :roomid => "335",
+         :siteid => "374"
+}
+```
+
+### `GET /search/people`
+
+This endpoint returns matching people and information about them.
+More: [Documentation](https://docs.uclapi.com/#get-people)
+
+```rb
+> people = client.search.people(query: 'John')
+[#<UCLAPI::People name="John Doe" ....>, ...]
+> people.first
+UCLAPI::People {
+        :status => "Staff",
+          :name => "John Doe",
+         :email => "j.doe@ucl.ac.uk",
+    :department => "UCL API Development"
+}
+```
+
+## Contributing
+
+ 1. **Fork** the repo on GitHub
+ 2. **Clone** the project to your own machine
+ 3. **Commit** changes to your own branch
+ 4. **Push** your work back up to your fork
+ 5. Submit a **Pull request** so that we can review your changes
+
+### Development
+
+* `bundle install` to get dependencies
+* `rake` to run tests
+* `rake console` to run a local console with the library loaded
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in this project is expected to follow the [code of conduct](https://github.com/cbetta/uclapi/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec 'irb -r uclapi -I ./lib -r awesome_print'
+end

data/lib/uclapi/booking.rb

@@ -0,0 +1,8 @@
+class UCLAPI::Booking < OpenStruct
+  def room
+    client.roombookings.rooms(
+      roomid: roomid,
+      siteid: siteid
+    ).first
+  end
+end

data/lib/uclapi/client/roombookings.rb

@@ -0,0 +1,26 @@
+class UCLAPI::Client::Roombookings
+  def initialize client
+    @client = client
+  end
+
+  def rooms(params = {})
+    @client.get('/roombookings/rooms', params)['rooms'].map do |room|
+      room[:client] = @client
+      UCLAPI::Room.new(room)
+    end
+  end
+
+  def bookings(params = {})
+    @client.get('/roombookings/bookings', params)['bookings'].map do |booking|
+      booking[:client] = @client
+      UCLAPI::Booking.new(booking)
+    end
+  end
+
+  def equipment(params = {})
+    @client.get('/roombookings/equipment', params)['equipment'].map do |equipment|
+      equipment[:client] = @client
+      UCLAPI::Equipment.new(equipment)
+    end
+  end
+end

data/lib/uclapi/client/search.rb

@@ -0,0 +1,12 @@
+class UCLAPI::Client::Search
+  def initialize client
+    @client = client
+  end
+
+  def people(params = {})
+    @client.get('/search/people', params)['people'].map do |people|
+      people[:client] = @client
+      UCLAPI::People.new(people)
+    end
+  end
+end

data/lib/uclapi/client.rb

@@ -0,0 +1,86 @@
+require 'net/https'
+require 'json'
+
+module UCLAPI
+  class Client
+    class ServerError < StandardError; end
+    class NotFoundError < StandardError; end
+    class BadRequestError < StandardError; end
+    class UnauthorizedError < StandardError; end
+
+    ENDPOINT = 'uclapi.com'.freeze
+
+    attr_accessor :token, :http, :debug
+
+    def initialize(options = {})
+      @token = options.fetch(:token) do
+        ENV['UCLAPI_TOKEN'] || raise(KeyError, "Missing required argument: token")
+      end
+
+      @debug = options.fetch(:debug) do
+        ENV['UCLAPI_DEBUG']
+      end
+
+      @http = Net::HTTP.new(ENDPOINT, Net::HTTP.https_default_port)
+      http.use_ssl = true
+
+      http.set_debug_output $stderr if debug
+    end
+
+    def roombookings
+      UCLAPI::Client::Roombookings.new(self)
+    end
+
+    def search
+      UCLAPI::Client::Search.new(self)
+    end
+
+    def get(path, params = {})
+      uri = uri_for(path, params)
+      message = Net::HTTP::Get.new(uri.request_uri)
+      transmit(message)
+    end
+
+    private
+
+    def uri_for(path, params = {})
+      uri = URI("https://#{ENDPOINT}#{path}")
+      uri.query = URI.encode_www_form(params.merge({
+        token: token
+      }))
+      uri
+    end
+
+    def transmit(message)
+      parse(http.request(message))
+    end
+
+    def parse response
+      data = json?(response) ? JSON.parse(response.body) : response.body
+
+      case response
+      when Net::HTTPSuccess
+        data
+      when Net::HTTPNotFound
+        raise NotFoundError, "Record not found (404)"
+      when Net::HTTPBadRequest
+        raise BadRequestError, data
+      when Net::HTTPUnauthorized
+        raise UnauthorizedError, "Access Denied (401)"
+      else
+        if json?(response)
+          raise ServerError, "HTTP #{response.code}: #{JSON.parse(response.body)}"
+        else
+          raise ServerError, "HTTP #{response.code}: #{response.body}"
+        end
+      end
+    end
+
+    def json?(response)
+      content_type = response['Content-Type']
+      json_header = content_type && content_type.split(';').first == 'application/json'
+      has_body = response.body && response.body.length > 0
+      json_header && has_body
+    end
+  end
+end

data/lib/uclapi/equipment.rb

@@ -0,0 +1,8 @@
+class UCLAPI::Equipment < OpenStruct
+  def room
+    client.roombookings.rooms(
+      roomid: roomid,
+      siteid: siteid
+    ).first
+  end
+end

data/lib/uclapi/people.rb

@@ -0,0 +1,2 @@
+class UCLAPI::People < OpenStruct
+end

data/lib/uclapi/room.rb

@@ -0,0 +1,18 @@
+class UCLAPI::Room < OpenStruct
+  def bookings
+    client.roombookings.bookings(
+      roomid: roomid
+    )
+  end
+
+  def equipment
+    client.roombookings.equipment(
+      roomid: roomid,
+      siteid: siteid
+    ).map do |equipment|
+      equipment.roomid = roomid
+      equipment.siteid = siteid
+      equipment
+    end
+  end
+end

data/lib/uclapi/version.rb

@@ -0,0 +1,3 @@
+module UCLAPI
+  VERSION = "0.1.0"
+end

data/lib/uclapi.rb

@@ -0,0 +1,8 @@
+require "uclapi/version"
+require 'uclapi/client'
+require 'uclapi/client/roombookings'
+require 'uclapi/client/search'
+require 'uclapi/room'
+require 'uclapi/booking'
+require 'uclapi/equipment'
+require 'uclapi/people'

data/uclapi.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "uclapi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "uclapi"
+  spec.version       = UCLAPI::VERSION
+  spec.authors       = ["Cristiano Betta"]
+  spec.email         = ["cristiano@betta.io"]
+
+  spec.summary       = "A wrapper for the UCL API"
+  spec.description   = "A wrapper for the UCL API"
+  spec.homepage      = "https://uclapi.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "awesome_print", "~> 1.8.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: uclapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cristiano Betta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !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: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: A wrapper for the UCL API
+email:
+- cristiano@betta.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/uclapi.rb
+- lib/uclapi/booking.rb
+- lib/uclapi/client.rb
+- lib/uclapi/client/roombookings.rb
+- lib/uclapi/client/search.rb
+- lib/uclapi/equipment.rb
+- lib/uclapi/people.rb
+- lib/uclapi/room.rb
+- lib/uclapi/version.rb
+- uclapi.gemspec
+homepage: https://uclapi.com
+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.13
+signing_key: 
+specification_version: 4
+summary: A wrapper for the UCL API
+test_files: []