breathe 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff2837bf3695cdf7014639abd4e60f70dca9f6832167e1c0846a08416c446212
-  data.tar.gz: 468036efeb1ef793a94c1568f92c0abda53a4a82e1b9ca16318a728396820c3f
+  metadata.gz: 96b92d21eb2bfb0d148c30e774fb209332d9d417921c26f1a51448ebea86a949
+  data.tar.gz: 863903e2d56dc255f219ed8b6da8164dc3e685c0c25e87db341319f49f21aab7
 SHA512:
-  metadata.gz: 339a9998eea5fdbce58e178ac1ec545a966da3593b8a44ff89ad77091f446a22b42fd85c72918cfa5233307c57c31639c1e7b6a66fce4d2b8c301bfd14221a2b
-  data.tar.gz: 93f1d9a8582071ae1f78471bbcd62c0f0d6a5c59bcf3fad2e9fa84adde101286cb7f33159397645b80f08ab470b0b693d740dedc80fbf35d717efb4201f6a89d
+  metadata.gz: 0447d915f7761db9d2c55728349d4d00655bc1b16f37be622de6c2b22288186836c0330198eca6b1267445a412c73fa8c9dcbb8bf95a48e5ff2135bd3d375d5c
+  data.tar.gz: 1d79b24732559cb2373eff989a23073295ffc8f7a2a940a2b5ccaa93c4ddcf8d2d9d8865a21e1223f07a6839e91262b0734d12576ee9d2872f6c69ebf4e3696d

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog]
 
+[0.3.2]
+
+- Support listing of training courses
+
 [0.3.1]
 
 - Fix bug with auto pagination
@@ -30,6 +34,7 @@ The format is based on [Keep a Changelog]
 
 - Allow listing of absences
 
+[0.3.2]: https://github.com/dxw/breathe_ruby/releases/tag/0.3.2
 [0.3.1]: https://github.com/dxw/breathe_ruby/releases/tag/0.3.1
 [0.3.0]: https://github.com/dxw/breathe_ruby/releases/tag/0.3.0
 [0.2.0]: https://github.com/dxw/breathe_ruby/releases/tag/0.2.0

data/README.md

@@ -66,6 +66,13 @@ client.employees.get(id)
 #=> [...]
 ```
 
+### List employee training courses
+
+```ruby
+client.employee_training_courses.list
+#=> [...]
+```
+
 ### Filtering
 
 You can also pass in arguments like so:

data/lib/breathe.rb

@@ -3,14 +3,17 @@ require "sawyer"
 require "breathe/version"
 require "breathe/client"
 require "breathe/response"
+require "breathe/resource"
 
 require "breathe/absences"
 require "breathe/sicknesses"
 require "breathe/employees"
+require "breathe/employee_training_courses"
 
 module Breathe
   class Error < StandardError; end
   class AuthenticationError < StandardError; end
   class UnknownError < StandardError; end
+  class NotSupportedError < StandardError; end
   # Your code goes here...
 end

data/lib/breathe/absences.rb

@@ -1,17 +1,8 @@
 module Breathe
-  class Absences
-    attr_reader :client
-
-    def initialize(client)
-      @client = client
-    end
-
-    def list(args = {})
-      client.response(
-        method: :get,
-        path: "absences",
-        args: args
-      )
-    end
+  class Absences < Resource
+    RESOURCE_NAME = "absences"
+    SUPPORTED_ENDPOINTS = [
+      :list,
+    ]
   end
 end

data/lib/breathe/client.rb

@@ -21,6 +21,10 @@ module Breathe
       @employees ||= Employees.new(self)
     end
 
+    def employee_training_courses
+      @employee_training_courses ||= EmployeeTrainingCourses.new(self)
+    end
+
     def response(method:, path:, args: {})
       response = request(method: method, path: path, options: {query: args})
       parsed_response = Response.new(response: response, type: path.split("/").first)

data/lib/breathe/employee_training_courses.rb

@@ -0,0 +1,8 @@
+module Breathe
+  class EmployeeTrainingCourses < Resource
+    RESOURCE_NAME = "employee_training_courses"
+    SUPPORTED_ENDPOINTS = [
+      :list,
+    ]
+  end
+end

data/lib/breathe/employees.rb

@@ -1,24 +1,9 @@
 module Breathe
-  class Employees
-    attr_reader :client
-
-    def initialize(client)
-      @client = client
-    end
-
-    def list(args = {})
-      client.response(
-        method: :get,
-        path: "employees",
-        args: args
-      )
-    end
-
-    def get(id)
-      client.response(
-        method: :get,
-        path: "employees/#{id.to_i}"
-      )
-    end
+  class Employees < Resource
+    RESOURCE_NAME = "employees"
+    SUPPORTED_ENDPOINTS = [
+      :list,
+      :get,
+    ]
   end
 end

data/lib/breathe/resource.rb

@@ -0,0 +1,34 @@
+module Breathe
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def list(args = {})
+      raise NotSupportedError unless self.class::SUPPORTED_ENDPOINTS.include?(:list)
+
+      client.response(
+        method: :get,
+        path: resource_name,
+        args: args
+      )
+    end
+
+    def get(id)
+      raise NotSupportedError unless self.class::SUPPORTED_ENDPOINTS.include?(:get)
+
+      client.response(
+        method: :get,
+        path: "#{resource_name}/#{id.to_i}"
+      )
+    end
+
+    private
+
+    def resource_name
+      @resource_name ||= self.class::RESOURCE_NAME
+    end
+  end
+end

data/lib/breathe/sicknesses.rb

@@ -1,17 +1,8 @@
 module Breathe
-  class Sicknesses
-    attr_reader :client
-
-    def initialize(client)
-      @client = client
-    end
-
-    def list(args = {})
-      client.response(
-        method: :get,
-        path: "sicknesses",
-        args: args
-      )
-    end
+  class Sicknesses < Resource
+    RESOURCE_NAME = "sicknesses"
+    SUPPORTED_ENDPOINTS = [
+      :list,
+    ]
   end
 end

data/lib/breathe/version.rb

@@ -1,3 +1,3 @@
 module Breathe
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breathe
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Stuart Harrison
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-24 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,7 +147,9 @@ files:
 - lib/breathe.rb
 - lib/breathe/absences.rb
 - lib/breathe/client.rb
+- lib/breathe/employee_training_courses.rb
 - lib/breathe/employees.rb
+- lib/breathe/resource.rb
 - lib/breathe/response.rb
 - lib/breathe/sicknesses.rb
 - lib/breathe/version.rb