supersaas-api-client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cd91008c369ed81daba9f3b18bf00e4d05ec9dd0e9251a1b3784b2a2c733c2e
-  data.tar.gz: 2f6140acf5eafe80cd6a393c9e1213c23702589fd9e83a1b0e715aca9ae16398
+  metadata.gz: f0594cc1556a00fbce6efb522bc71f4aa359367a5523a6350661e127b2e4938b
+  data.tar.gz: 3c9f1d8520d2c631e560769d4d83e45f0b845a9f1e16d367baf69c8ae718d687
 SHA512:
-  metadata.gz: d3fd7377e8aca4df5bd47ea3dc26211fd4eecc2c2406cfb55c4d914804b589c899ad5f0d2d8764f70de36f1a9d3646a9839219d9ae688bfa40dff905652dd793
-  data.tar.gz: 0ae95b465f2b6c48c07e9125be5a740483b268e23e9262805d3b63fd8971c6f4fd546128cc276fdae1e94549b2b15840f44018abb17c35e7257da3e3a29e75cb
+  metadata.gz: e687af87475439d8759f7833723ff14d6d04e418b80c7857bc14dbbc1be6140ef6855e5fe4874abada6512fa9b71a95d755c2871613854610b14a03c7d44bdfe
+  data.tar.gz: 7042e08b1629897c493ce6edb88715cd5340c0f4325822540050eef8adc701416a94e2cd670a8d19332c7708416ef6480a150b0e80cc525001e26b766be0a236

data/.gitignore

@@ -8,4 +8,3 @@
 /tmp/
 .DS_Store
 .idea/*
-*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    supersaas-api-client (0.10.0)
+    supersaas-api-client (1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,10 +13,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 1.17.3)
   minitest (~> 5.0)
   rake (~> 10.0)
   supersaas-api-client!
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/README.md

@@ -145,13 +145,13 @@ List appointments by `schedule_id`, with `form` and `start_time` and `limit` vie
 
 Get agenda (upcoming) appointments by `schedule_id` and `user_id`, with `from_time` view param:
 
-    Supersaas::Client.instance.appointments.agenda(12345, 67890, '2018-1-31 00:00:00') #=> [<Supersaas::Appointment>, ...]
+    Supersaas::Client.instance.appointments.agenda(12345, 67890, '2018-01-31 00:00:00') #=> [<Supersaas::Appointment>, ...]
 
 #### Get Agenda Slots
 
 Get agenda (upcoming) slots by `schedule_id` and `user_id`, with `from_time` view param:
 
-    Supersaas::Client.instance.appointments.agenda_slots(12345, 67890, '2018-1-31 00:00:00') #=> [<Supersaas::Slot>, ...]    
+    Supersaas::Client.instance.appointments.agenda_slots(12345, 67890, '2018-01-31 00:00:00') #=> [<Supersaas::Slot>, ...]    
 
 _Note: works only for capacity type schedules._
 
@@ -159,25 +159,27 @@ _Note: works only for capacity type schedules._
 
 Get available appointments by `schedule_id`, with `from` time and `length_minutes` and `resource` params:
 
-    Supersaas::Client.instance.appointments.available(12345, '2018-1-31 00:00:00', 15, 'My Class') #=> [<Supersaas::Appointment>, ...]
+    Supersaas::Client.instance.appointments.available(12345, '2018-01-31 00:00:00', 15, 'My Class') #=> [<Supersaas::Appointment>, ...]
 
 #### Get Recent Changes
 
-Get recently changed appointments by `schedule_id`, with `from_time` view param:
+Get recently changed appointments by `schedule_id`, with `from` time, `to` time and `slot` view param:
 
-    Supersaas::Client.instance.appointments.changes(12345, '2018-1-31 00:00:00', true) #=> [<Supersaas::Appointment>, ...]
+    Supersaas::Client.instance.appointments.changes(12345, '2018-01-31 00:00:00', '2019-01-31 00:00:00',  true) #=> [<Supersaas::Appointment>, ...]
 
-#### Get Recent Changes Slots
 
-Get recently changed slots by `schedule_id`, with `from_time` view param:
+#### Get list of appointments
+
+Get list of appointments by `schedule_id`, with `today`,`from` time, `to` time and `slot` view param:
+
+    Supersaas::Client.instance.appointments.range(12345, false, '2018-01-31 00:00:00', '2019-01-31 00:00:00', true) #=> [<Supersaas::Appointment>, ...]/[<Supersaas::Slot>, ...]
 
-    Supersaas::Client.instance.appointments.changes_slots(12345, '2018-1-31 00:00:00', true) #=> [<Supersaas::Slot>, ...]
 
 #### List Template Forms
 
 Get all forms by template `superform_id`, with `from_time` param:
 
-    Supersaas::Client.instance.forms.list(12345, '2018-1-31 00:00:00') #=> [<Supersaas::Form>, ...]
+    Supersaas::Client.instance.forms.list(12345, '2018-01-31 00:00:00') #=> [<Supersaas::Form>, ...]
 
 #### Get Form
 

data/examples/appointments.rb

@@ -73,7 +73,7 @@ end
 
 puts "\n\rlisting changes..."
 from = DateTime.now - 120
-puts "\n\r#### Supersaas::Client.instance.appointments.changes(#{schedule_id}, '#{from.strftime("%Y-%m-%d %H:%M:%S")}', #{show_slot || 'false'})\n\r"
+puts "\n\r#### Supersaas::Client.instance.appointments.changes(#{schedule_id}, '#{from.strftime("%Y-%m-%d %H:%M:%S")}', '#{to.strftime("%Y-%m-%d %H:%M:%S")}',  #{show_slot || 'false'})\n\r"
 
 Supersaas::Client.instance.appointments.changes(schedule_id, from, show_slot)
 

data/lib/supersaas-api-client/api/appointments.rb

@@ -117,21 +117,19 @@ module Supersaas
       client.delete(path, nil, params)
     end
 
-    def changes(schedule_id, from_time)
+    def changes(schedule_id, from_time=nil, to=nil, slot=false)
       path = "/changes/#{validate_id(schedule_id)}"
-      params = { from: validate_datetime(from_time) }
+      params = build_param({}, from_time, to, slot)
       res = client.get(path, params)
       map_slots_or_bookings(res)
     end
 
-    def changes_slots(schedule_id, from_time)
-      path = "/changes/#{validate_id(schedule_id)}"
-      params = {
-        from: validate_datetime(from_time),
-        slot: true
-      }
+    def range(schedule_id, today=false, from_time=nil, to=nil, slot=false)
+      path = "/range/#{validate_id(schedule_id)}"
+      params = {}; params.merge!(today: true) if today
+      params = build_param(params, from_time, to, slot)
       res = client.get(path, params)
-      map_slots_or_bookings(res, true)
+      map_slots_or_bookings(res)
     end
 
     private
@@ -149,5 +147,12 @@ module Supersaas
         []
       end
     end
+
+    def build_param(params, from_time, to, slot)
+      params.merge!(from: validate_datetime(from_time)) if from_time
+      params.merge!(to: validate_datetime(to)) if to
+      params.merge!(slot: true) if slot
+      params
+    end
   end
 end

data/lib/supersaas-api-client/client.rb

@@ -121,6 +121,10 @@ module Supersaas
         json_body(res)
       when 422, 400
         json_body(res)
+      when 401
+        raise Supersaas::Exception.new("HTTP Request Error: Unauthorised")
+      when 404
+        raise Supersaas::Exception.new("HTTP Request Error: Not Found")
       else
         {}
       end

data/lib/supersaas-api-client/version.rb

@@ -1,4 +1,4 @@
 module Supersaas
   API_VERSION  = '2'
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/supersaas-api-client.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 1.17.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

data/test/appointments_test.rb

@@ -65,10 +65,10 @@ module Supersaas
       assert_last_request_path "/api/changes/#{@schedule_id}.json?#{URI.encode_www_form(from: from)}"
     end
 
-    def test_changes_slots
-      from = Time.now
-      refute_nil @client.appointments.changes_slots(@schedule_id, from)
-      assert_last_request_path "/api/changes/#{@schedule_id}.json?#{URI.encode_www_form(from: from.strftime("%Y-%m-%d %H:%M:%S"))}&slot=true"
+    def test_range
+      from = "2017-01-31 14:30:00"
+      refute_nil @client.appointments.range(@schedule_id, false, from)
+      assert_last_request_path "/api/range/#{@schedule_id}.json?#{URI.encode_www_form(from: from)}"
     end
 
     def test_delete

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: supersaas-api-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Travis Dunn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 1.17.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 1.17.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Online bookings/appointments/calendars using the SuperSaaS scheduling platform.