centaman 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 346951239d8d7ce42e7a21d378f6c05548e8fb1a
-  data.tar.gz: 49024f7fe2429951476d5d95e2553386411bbfbc
+  metadata.gz: 60b36486d591b1b3c1e2aefc10c00c6b5411b2c4
+  data.tar.gz: 63238c5bf788e3c2db1aff88c8359db8834f36d8
 SHA512:
-  metadata.gz: d55b12e7d7d027dcfef8918d18eeb008af1400d7b23b05fa338582cffbc8829ed28b21816027dd1eebcfb01507f9390d8bdd64441d0259fa8ab679c59d0dbacd
-  data.tar.gz: 04af5d088e7c0a6a902599b078d1a2b0233c4a3c76c47638002e45a64b0b45f12be44909cd1d8527c5e3d81be739656d764b1e637f6200ae3a2f64acd6c95af7
+  metadata.gz: 75cc2bfd6a061e2a7fbee528de18a11444e7a0ebba2ef5550781913541b14451fa6f406d58d357d1eb919c4e279ed5c7fa06564a31647d5c263a78cce376a0bb
+  data.tar.gz: 8dd3c2a6f0cddf2255afb9231e118a834d619ade49dc6ce11db5afcf28225f98b6e389fc7911e55d715f58937f04431fb26dfda91c709b7103b198aaee0a6ac5

data/README.md

@@ -1,6 +1,6 @@
 # Centaman
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/centaman`. To experiment with that code, run `bin/console` for an interactive prompt.
+A wrapper for the Centaman Ticketing API.
 
 TODO: Delete this and the text above, and describe your gem
 
@@ -22,16 +22,41 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Retrieve Booking Type Objects for a certain date
+- Defaults to current date if no date parameters given
+```ruby
+  Centaman::Service::BookingType.new(start_date: DATE, end_date: DATE).objects
+```
+
+Find a Booking Type
+- Requires the booking type id (integer) and date 
+```ruby
+  Centaman::Service::BookingType.find(BOOKING_TYPE_ID, DATE)
+```
+
+Retrieve Booking Time Objects for a Booking Type
+- Requires the associated booking_type_id (integer)
+- start_date && end_date required to retrieve booking times for a specific date, else defaults to current date
+```ruby
+  Centaman::Service::BookingTime.new(booking_type_id: ID, start_date: DATE, end_date: DATE).objects
+```
+
+Find a Booking Time
+- Requires the associated booking type id (integer), booking time id (integer), and date
+```ruby
+  Centaman::Service::BookingTime.find(BOOKING_TYPE_ID, BOOKING_TIME_ID, DATE)
+```
+
 
 ## Required Environment Variables
 
 This gem assumes the following environment variables are defined by the application
 
-- CENTAMAN_API_URL (Centaman API endpoint, ex: https://taxi.centaman.net/CentamanAPI)
-- CENTAMAN_API_USERNAME (Centaman API username)
-- CENTAMAN_API_PASSWORD (Centaman API password)
-- FIXIE_URL (Optional. Used with FIXIE proxy to route outbound requests through a set of static IP addresses)
+- CENTAMAN_API_URL
+- CENTAMAN_API_USERNAME
+- CENTAMAN_API_PASSWORD
+- CENTAMAN_API_TOKEN (Optional. Required if CENTAMAN_API_USERNAME and CENTAMAN_API_PASSWORD are not provided.)
+- FIXIE_URL (Optional. Used with FIXIE proxy to route outbound requests through a set of static IP addresses.)
 
 ## Development
 

data/lib/centaman/version.rb

@@ -1,3 +1,3 @@
 module Centaman
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: centaman
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - francirp